Skip to content


The Unryo REST API allows you to interact programmatically with Unryo using RESTful requests over the HTTP protocol.

The Unryo APIs allows you to programmatically interact with Unryo at every level.

API Endpoints Description
Unryo Alert API List and manage alerts from the Alarm Console.
Unryo Portal API List and manage users (create, delete). Return dashboards URL (by specifying a resource name & type)
Unryo Monitor APIs Retrieve log data. Retrieve tracing data. Retrieve historical events. Push custom data into Unryo
Unryo Vault API Manage data collection configurations. Manage alerting rules. Manage data enrichment/tagging to add contextual information/metadata to metrics and events.


The Unryo API supports HTTP Basic authentication.

HTTP Basic authentication authorizes requests by passing the username and password in the header of each request. You can authenticate requests with the same login ID and password that you use to log on to the Unryo web user interface.

$ curl -u username:password -I "https://<mycompany>"

## Or

$ curl -H "Authorization: Basic xxxxxxxxxxxx" -k "https://<mycompany>"

Generate your Basic authentification token#

The Authorization: Basic token is a base64 of your username and password with a : between username:password.

$ echo -n 'username:password' | base64


$ curl -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ" -k "https://<mycompany>"

All the query need to be AUTHENTICATED with the basic auth

Response Codes#

Unryo uses conventional HTTP response codes to indicate the success or failure of an API request. When a request is successful, Unryo sends a response code to indicate that it received the message. If a request fails, the response code may help with troubleshooting an error.

This table below lists some of the common response codes you may receive from the Unryo API.

Response Description
200 OK Success.
201 Created New resource created.
204 No Content There is no content to send for this request.
400 Bad Request Default code for invalid requests. For example, it is missing a mandatory field. Check the error message and ensure that the JSON includes the correct parameters.
401 Unauthorized Token is invalid or missing. Check that the request includes the correct HTTP headers.
403 Forbidden Access denied.
404 Not Found Requested endpoint isn't available. Ensure that the request uses one of the API endpoints specified in the documentation.
409 Conflict Request cannot be performed due to a conflict.
410 Gone Requested resource is no longer available and has been removed permanently. Consult the documentation to see what endpoints are supported currently.
500 Internal Server Error Default code for errors that occur due to problems on Unryo servers. Retry the request after some time.
501 Not Implemented Unsupported method.