Skip to main content
GET
List alerts

Authorizations

X-API-Key
string
header
required

Your API key in the X-API-Key header.

Headers

X-Case-Id
string | null

Active case, optional: the token of a case you can view. The query is recorded in that case and also uses its own labels. A case that does not exist, was deleted or is no longer shared with you returns 400 case_unavailable and the query is not run, with no charge.

Query Parameters

status
string | null
default:active

Alert status. active (the default) means open plus acknowledged; open, acknowledged, resolved, dismissed, retracted and all are also accepted. Any other value returns 400.

watch_id
integer | null

Id of a watch, as returned by GET /v1/guard/watches. Returns only its alerts.

severity
string | null

Severity: low, medium, high or critical. Empty returns all.

limit
integer
default:100

Maximum number of alerts per page, from 1 to 500. A value outside that range is adjusted to the nearest limit. Defaults to 100.

before_id
integer | null

Pagination cursor. Returns alerts with an id lower than this one; use the next_before_id from the previous response. Empty starts from the most recent.

protocol_id
integer | null

Id of a protocol, as returned by GET /v1/guard/protocols. Returns only the alerts of its contracts.

Response

Successful response.