Alarms

List host/control-plane-wide alarms with optional filters.

get/system/alarms

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/system/alarms
  • Auth: HTTP bearer

Query parameters

alarm_typestring nullable

Filter by alarm type (e.g. container_restart, outage).

statusstring nullable

Filter by status: firing, acknowledged, or resolved.

severitystring nullable

Filter by severity: info, warning, or critical.

environment_idinteger nullable

Filter by environment ID.

deployment_idinteger nullable

Filter by deployment ID.

service_idinteger nullable

Filter by external service ID.

pageinteger nullable

Page number (1-based, default 1).

page_sizeinteger nullable

Items per page (default 20, max 100).

Response

Paginated list of system alarms

pageinteger required
page_sizeinteger required
totalinteger required

Changes

No recorded changes to this operation across all 54 revisions of this API.