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

Clear Orchestrator alarms

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

Clears one or more Orchestrator (GMS) alarms by their unique IDs. The clearance is recorded with the authenticated user's information. Only active alarms that exist can be cleared.

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

Object containing the list of Orchestrator alarm IDs to clear.

Request body for clearing Orchestrator alarms.

ids
array of int64s
required
length ≥ 1

Array of Orchestrator alarm IDs to clear. Each ID must be a positive integer representing an existing active alarm.

ids*

Unique identifier of an Orchestrator alarm.

Responses
204

Alarms cleared successfully. No content is returned on success.

Updated about 11 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 11 hours ago

Did this page help you?