REST API access

This functionality is available in: System Settings > Administration > REST API access

Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.

Options to set:

• Port - which as default is set to 82. You cannot indicate ports already in use.
• Username - is an authentication username. The default is “admin”.
• Password - which is used for authentication.
• Password confirmation - means retype your new password.

Below are examples of requests using the curl command:

• for GET request:

curl -X GET -u username:password -i -k -H "Content-type: application/json" https://ip_address:port/api/v3/product

• for PUT request:

curl -X PUT -u username:password -i -k -H "Content-type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://ip_address:port/api/v3/services/remote-logging

• for POST request:
  Note! In the example below, LDAP must be enabled in the system. Otherwise, an error occurs.

curl -X POST -u username:password -i -k -H "Content-type: application/json" -d '{"name": "username", "password": "password", "backend_name": "LDAP"}' https://ip_address:port/api/v3/users