Configuration API Service
Configuration API Service
The Configuration API allows an HTTPS RESTful client to add, edit, read, and delete objects such as channels, devices, and tags in the server. The Configuration API offers the following features:
• Object definition in standard human-readable JSON data format
• Support for triggering and monitoring actions on some objects within the server
• Security via HTTP basic authentication and HTTP over SSL (HTTPS)
• Support for user-level access based on the User Manager and Security Policies Plug-In
• Transaction logging with configurable levels of verbosity and retention
Note: This document assumes familiarity with HTTPS communication and REST concepts.Initialization - The Configuration API is installed as a Windows service and starts automatically with the system.
Operation - The Configuration API supports connections and commands between the server and REST clients.
Shutdown - If the Configuration API must be stopped, use the Windows Service Control Manager to terminate the Configuration API service.
If the Configuration API must be stopped, use the systemctl to stop the service.
Security
REST clients to the Configuration API must use HTTPS Basic Authentication. The user credentials are defined in the server User Group. Initial login to the Configuration API with Basic Authentication uses the Administrator user name and the password set during installation. Additional users and groups should be created to allow appropriate access.
REST clients to the Configuration API must use HTTPS Basic Authentication or Bearer Token Authentication. The user credentials are defined in the server User Manager. Initial login to the Configuration API with Basic Authentication uses the Administrator user name and the password set during installation. Additional users and groups should be created to allow appropriate access; an Active Directory user is required to use Bearer Token Authentication.
For information regarding how to use the Configuration API with Active Directory users, see the User Manager.
The product Administrator password must be at least 14 characters and no more than 512 characters. Passwords should be at least 14 characters and include a mix of uppercase and lowercase letters, numbers, and special characters. Choose a strong unique password that avoids well-known, easily guessed, or common passwords. Passwords greater than 512 characters will be truncated. The Administrator user account password cannot be reset, but additional administrative users can be added to the Administrator user group. Best practices suggest each user with administrative access be assigned unique accounts and passwords to ensure audit integrity and continual access through role and staff changes. Individual user accounts are locked for 10 minutes after 10 successive login attempts with different, incorrect passwords.Documentation
Please consult additional information on properties, data ranges, endpoint mapping scheme, and acceptable actions for each endpoint is available at the Configuration API Landing Page at https://<hostname_or_ip>:<port>/config/ (for default configurations). Documentation is obtained as JSON-encoded documentation.