Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Alerts

List alerts

get/v1/alert

Query parameters

device_idstring

ID of a device

Example:d_0123456789ab
agent_idstring

ID of an agent

Example:a_0123456789ab
resolvedboolean

Whether the alert has been resolved

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

sort_by'created'

Sort by a specific field

sort_ascboolean

Sort in ascending order

created_afterstring date-time

Filter results to after a specific creation timestamp (RFC3339 format)

created_beforestring date-time

Filter results to before a specific creation timestamp (RFC3339 format)

Response

OK

Example response

{
  "data": [
    {
      "agent_id": "a_0123456789ab",
      "alert_id": "al_0123456789ab",
      "alert_type": "device_not_checking_in",
      "created_at": "2024-08-23T01:25:08Z",
      "device_id": "d_0123456789ab",
      "resolved_at": "2024-08-23T01:25:08Z",
      "resolved_by": "John Smith"
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}