Alerts

ListDeviceAlerts

Fetch device alerts. For more information, see our nRF Cloud documentation on device alerts.

get/alerts

Query parameters

deviceIdsDeviceId[]

Fetch alerts optionally by device ids.

[
  "nrf-1234567890123456789000"
]

status'ACTIVE' | 'ARCHIVED'

ACTIVE: The alert is active and has not been resolved. ARCHIVED: The alert has been resolved and is no longer active.

Fetch alerts optionally by Status. By default, both ACTIVE and ARCHIVED alerts are returned.

pageLimitinteger

Maximum number of items you want returned in the response (<=100).

pageSort'asc' | 'desc'

Sorting order for the paginated results => desc (descending; default) or asc (ascending).

Example:desc

pageNextTokenstring

If available in the initial response, use this token to retrieve the next page of items in the list. When supplying as a request parameter, use URL-encoding.

Example:4bb1f9ab35bd

Response

totalinteger

Reflects the total results returned by the query, which may be less than the total number of items available. If the response contains a pageNextToken value, you can supply the pageNextToken in the next request to get more results. The maximum value of total is the page limit of the request, or ten pages if no page limit is provided.

pageNextTokenstring

Token used to retrieve the next page of items in the list. Present in a response only if the total available results exceeds the specified limit on a page. This token does not change between requests. When supplying as a request parameter, use URL-encoding.

Example response

{
  "items": [
    {
      "id": "bc631093-7f7c-4c1b-aa63-a68c759bcd5c",
      "deviceId": "nrf-1234567890123456789000",
      "createdAt": "2020-06-25T21:05:12.830Z",
      "receivedAt": "2020-06-25T21:05:12.830Z",
      "statusChangedAt": "2020-06-25T21:05:12.830Z",
      "statusChangedBy": "bc631093-7f7c-4c1b-aa63-a68c759bcd5c"
    }
  ],
  "total": 10,
  "pageNextToken": "4bb1f9ab35bd"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.