Every OT-BASE Asset Discovery node comes with an integrated REST API that allows you to make configuration changes (such as changing access credentials for WMI or SNMP) programatically.
The REST API is particularly useful if you are operating hundreds of Asset Discovery nodes, and applying configuration changes manually e.g. via OT-BASE Discovery Manager proves too time consuming.
Connecting to the REST API
In order to connect to the REST API of an Asset Discovery node, open an HTTPS connection to the node's IP address and the TCP port you have configured (default: 443).
HTTPS means that your data is encrypted on transport. Asset Discovery uses a self-signed certificate, so your client software will probably notify you that the authenticity of the server cannot be verified or that the certificate is expired. Since Asset Discovery is intended to run only in trusted networks, we suggest to ignore such a warning. HTTPS is used here only for encryption, not for authentication.
After connection establishment you have to authenticate using the user ID and password that you have configured for the node.
Authentication via an LDAP account is not possible. For the authentication method use "basic authentication".
|PUT||Change configuration / trigger an action|
The content type for the body is always "application/json".
|Successfully processed the request, includes a response body|
|202||Accepted the request but processing is not completed|
|204||Successfully processed the request, without a response body|
|400||An error occurred. See the response body for more information|
|404||Resource not found. See the response body for more information|
|405||Method not allowed. See the response body for more information|