HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. alarm

Acknowledge or unacknowledge Orchestrator alarms

post
http://127.0.0.1:8080/alarm/acknowledgement/gms

Toggles the acknowledgment status of one or more Orchestrator alarms. The acknowledging user is automatically captured from the authenticated session. Only affects active (non-closed) alarms.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Alarm acknowledgment request containing alarm IDs and acknowledgment action

Request body for acknowledging or unacknowledging Orchestrator alarms

boolean
required
Defaults to false

Set to true to acknowledge alarms, false to remove acknowledgment (unacknowledge). Default is false if not specified.

ids
array of integers
required
length ≥ 1

List of Orchestrator alarm IDs to acknowledge or unacknowledge. Must contain at least one valid alarm ID.

ids*

Unique identifier of an Orchestrator alarm

Responses
204

Alarms acknowledged or unacknowledged successfully. No content returned.

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain

Updated about 12 hours ago

Did this page help you?