Skip to content

Alarm API

The Alarm API provides active alarm queries, alarm history, and alarm management.

Lists active (triggered) alarms with pagination.

ParameterTypeDescription
projectIdIntegerProject ID
pageIntegerPage number (default: 0)
sizeIntegerPage size (default: 20)
Terminal window
curl -b cookies.txt \
"http://localhost:8081/api/alarms/fired-alarms?projectId=153" \
-H "X-Space: claude"

Response:

{
"content": [],
"pageable": {
"pageNumber": 0,
"pageSize": 20
},
"totalPages": 0,
"totalElements": 0,
"empty": true
}

Lists the entire alarm history (including closed alarms).

MethodEndpointDescription
POST/api/alarms/fired-alarms/acknowledgeAcknowledge an alarm
POST/api/alarms/fired-alarms/force-offForce-close an alarm
Terminal window
curl -b cookies.txt -X POST \
http://localhost:8081/api/alarms/fired-alarms/acknowledge \
-H "X-Space: claude" -H "Content-Type: application/json" \
-d '{"id": 12345}'
MethodEndpointDescription
GET/api/alarms?projectId=XList alarm definitions
POST/api/alarmsCreate a new alarm definition
PUT/api/alarms/{id}Update an alarm
DELETE/api/alarms/{id}Delete an alarm
MethodEndpointDescription
GET/api/alarm-groups?projectId=XList alarm groups
POST/api/alarm-groupsCreate a new group
PUT/api/alarm-groups/{id}Update a group
DELETE/api/alarm-groups/{id}Delete a group
POST/api/alarm-groups/{id}/activateActivate a group
POST/api/alarm-groups/{id}/deactivateDeactivate a group