v1

latestOpenAPI 3.0.02026-07-14512083.9 KB

Fetch information for a specific Check failure

get/failures/{id}

Path parameters

idstring required

The id of the checkFailure

Response

Information about one Check failure

idstring

The canonical identifier for this failure

check_idstring

The canonical identifier of the check this failure is for

failure_keystring

The name of the primary key that distinguishes one failure from another in the context of a single check failure definition. May not be applicable

failure_valuestring

The primary value of the failure. May not be applicable

titlestring

The short description of the failure

valueobject

The information that defines this failure

ignoredboolean

Whether this failure has been ignored. Ignoring failures is useful to allowlist single instances of check failures when they are determined to be false positives or acceptable risk.

escalation_statusstring

Describes the escalation status of this failure. A failure may be escalated because user contact attempts were exhausted, the user asked for help, or because the device generating the failure does not have a device owner

resolved_atstring date-time

The timestamp when this failure was resolved. Will be null if the failure is ongoing.

timestampstring date-time

When the failure was initially detected

first_notified_owner_atstring date-time

The timestamp the owner of the device was first notified. Can be null if no notification has been triggered