Skip to main content
POST
Acknowledge an operational alert

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255
X-Request-ID
string

Request correlation identifier. Generated when omitted.

Path Parameters

id
string<uuid>
required

The alert to acknowledge.

Body

application/json
note
string

Optional operator note recorded with the acknowledgement (≤500 characters).

Maximum string length: 500

Response

OK

active
boolean
required

Whether the alert is active. false appears only when activeOnly=false surfaces deactivated (history) alerts.

id
string<uuid>
required

Alert id; the opaque key consumers address the alert by — acknowledgeAlert on this rail — and correlate to the alert.{raised,cleared,acknowledged} facts.

raisedAt
string<date-time>
required

Alert raise instant.

type
enum<string>
required

Alert type.

Available options:
WINDOW_CLOSING,
RECALCULATION,
RELAY_DOWN,
CERTIFICATE_EXPIRY,
CONNECTION_DOWN,
SCHEDULE_CHANGE,
CAMARA_INTERRUPTED,
CAMARA_CLOSED,
COLLATERAL_REQUIRED,
COLLATERAL_SUBSTITUTION,
ELIGIBLE_ASSETS_CHANGED,
INBOUND_QUARANTINED,
FOREIGN_TENANT_COMMAND,
INBOUND_SEMANTIC_REJECTED,
OUTBOUND_DISPATCHER_DOWN,
UNANSWERED_REQUEST,
OT_REPLAY_DOWN,
XSD_VALIDATOR_DOWN
complementWindowClosesAt
string<date-time>

For a RECALCULATION alert whose cycle holds an active recálculo round, the round's complement/deposit deadline, projected verbatim from ot_recalculations.complement_window_closes_at; omitted otherwise.

cycleId
string<uuid>

Correlated cycle id; omitted for a connection-level alert (e.g. RELAY_DOWN).

deadlineAt
string<date-time>

Absolute deadline this alert tracks (e.g. a WINDOW_CLOSING deposit close or a CERTIFICATE_EXPIRY not-after), projected verbatim from alerts.deadline_at; omitted when the stored column is NULL.

details
any

Structured payload of an accumulating alarm, projected verbatim from alerts.details; omitted when the stored column is NULL. A FOREIGN_TENANT_COMMAND alert keeps ONE row for a whole episode and carries count and lastTenantId here, so this is the only place the size of that episode is visible. An UNANSWERED_REQUEST alert carries the request it names: outboundMessageId, codMsg, numCtrlIf and dispatchedAt; the deadline that was crossed is deadlineAt.

message
string

Operator-facing alert message; omitted when the stored message is empty.