API reference

Alerts

Monitoring alerts and their review.

List alerts

GET/v1/alerts

Scopes
monitoring:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200AlertList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Resolve an alert

POST/v1/alerts/{alert_id}/resolve

Scopes
monitoring:resolve
Required header
Idempotency-Key
Required header
If-Match

Parameters

FieldTypeRequired
alert_idpathstring (uuid)yes

Request bodyReviewResolve

FieldTypeRequired
resolutionenum: approve, reject, request_evidence, inconclusiveyes
reason_codesarray of stringyes
evidence_idsarray of string (uuid)yes
notestringyes
kyb_conflict_decisionsarray of KybConflictDecisionno
approval_idstring (uuid)no
resolution_payload_sha256stringno

Responses

  • 200Alert
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503