NRnrfcloud
Alerts

ArchiveDeviceAlert (Deprecated)

Changed on

Deprecated. Device alerts are being retired and this endpoint may be removed in a future release. For legacy alerts migration details, see Migrate nRF Cloud Alerts to Memfault Trace Events.

Archives an Alert. For more information, see our nRF Cloud documentation on device alerts.

patch/alerts/{id}/archive

Request

Path parameters

idstring required

Universally unique identifier

Example:bc631093-7f7c-4c1b-aa63-a68c759bcd5c

The unique identifier for the alert

Response

Ok

idstring required

Universally unique identifier

deviceIdstring required

This is the canonical device id used in the device certificate, and as the MQTT client id.

createdAtstring date-time

HTML-encoded ISO-8601 date-time string denoting the start or end of a date range. If the string includes only a date, the time is the beginning of the day (00:00:00).

receivedAtstring date-time required

HTML-encoded ISO-8601 date-time string denoting the start or end of a date range. If the string includes only a date, the time is the beginning of the day (00:00:00).

statusChangedAtstring date-time required

HTML-encoded ISO-8601 date-time string denoting the start or end of a date range. If the string includes only a date, the time is the beginning of the day (00:00:00).

statusChangedBystring required

Universally unique identifier

status'ARCHIVED' required

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

originalMessageobject required

The original message sent from the device that triggered the alert.

Example response

{
  "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"
}

Changes