Welcome to the Unomaly REST API Reference!

This is the reference manual for interacting with the Unomaly REST API. For more information, see the Unomaly product Documentation. You may want to start with the core concepts of Unomaly.

To generate credentials to access the API, you need to configure at least one Basic authentication in Settings > Authentication. See documentation.

Use the username and password of the authentication to create an authentication header base64(username + ":" + password)

Send API requests to your running instance of Unomaly at https://{your-unomaly-instance}/api/v2/.

Sending a request to get a list of groups using username api and password password.

  GET https://{your-unomaly-instance}/api/v2/groups HTTP/1.1
  Authorization: Basic YXBpOnBhc3N3b3Jk

Expected response with two groups:

  {
    items: [{
      id: "3",
      name: "group-a",
      created: "2019-10-01T08:32:36.649Z",
      updated: "2019-10-01T08:32:36.649Z",
    },
    {
      id: "4",
      name: "group-b",
      created: "2019-10-05T11:13:56.262Z",
      updated: "2019-10-07T09:53:23.853Z",
    }],
    total: 2
  }

Most responses for lists of entities are paginated by default. You can usually supply a limit query parameter to control how many results are being returned. In the result, there may be a next and/or prev cursor being returned. You can use these to get the next or previous set of items in the list. The cursors are only valid as long as the sorting field and order are unchanged. You can change the limit to vary the number of elements returned. A response returning next or prev cursors doesn't not guarantee there are more results to be returned.

Getting the first group:

  GET https://{your-unomaly-instance}/api/v2/groups?limit=1 HTTP/1.1
  Authorization: Basic YXBpOnBhc3N3b3Jk

Expected response:

  {
    items: [{
      id: "3",
      name: "group-a",
      created: "2019-10-01T08:32:36.649Z",
      updated: "2019-10-01T08:32:36.649Z",
    }],
    total: 2,
    next: "WzE2NSwiYm9vMiJd",
    prev: "WzE2NiwiYm9vMngiXQ",
  }

You can now use the next cursor to get the next set of results.

  GET https://{your-unomaly-instance}/api/v2/groups?limit=1&next=WzE2NSwiYm9vMiJd HTTP/1.1
  Authorization: Basic YXBpOnBhc3N3b3Jk

Expected response:

  {
    items: [{
      id: "4",
      name: "group-b",
      created: "2019-10-05T11:13:56.262Z",
      updated: "2019-10-07T09:53:23.853Z",
    }],
    total: 2,
    next: "WzE2NiwiYm9vMngiXQ",
    prev: "WzE2NiwiYm9vMngiXQ",
  }

Groups, see Unomaly documentation on systems and groups

Systems, see Unomaly documentation on systems and groups