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

Clear appliance alarms

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

Clears one or more alarms on a specific appliance by providing alarm identifiers. The user performing the clearance is automatically captured from the session. An action log entry is created for auditing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

Body Params

Contains the list of alarm actions specifying which alarms to clear.

Request body containing alarm actions for clearing alarms on an appliance.

actions
array of objects
required

List of alarm actions identifying which alarms to clear.

actions*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

204

All alarms cleared 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:
application/json
text/html

Updated about 12 hours ago

Did this page help you?