Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Alerts

Update alert

patch/v1/alert/{alert_id}

Path parameters

alert_idstring required

ID of an alert

Example:al_0123456789ab

Request body

resolvedboolean

Whether the alert has been resolved

Response

OK

agent_idstring

ID of an agent

alert_fieldsstring required

Unstructured fields specific to the alert type

alert_idstring required

ID of an alert

alert_type'device_not_checking_in' | 'device_out_of_date' | 'device_storage_not_healthy' | 'device_storage_space_low' | 'device_storage_space_critical' | 'agent_not_checking_in' | 'agent_not_backing_up' | 'agent_backup_failed' | 'agent_duplicate_connection' required

Type of the alert

created_atstring date-time required

Creation timestamp

device_idstring

ID of a device

resolvedboolean required

Whether the alert has been resolved

resolved_atstring date-time

Timestamp at which an alert was resolved

resolved_bystring

Name of the person who resolved the alert, or "auto" if resolved automatically

Example response

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