Acknowledge or unacknowledge appliance alarms

post

http://127.0.0.1:8080/alarm/acknowledgement/appliance

Acknowledges or unacknowledges alarms on an appliance by specifying alarm sequence IDs. The current user is automatically recorded as the acknowledging user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

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

Body Params

Alarm acknowledgement configuration specifying the alarms to acknowledge/unacknowledge.

Request body for acknowledging or unacknowledging appliance alarms.

acknowledge

boolean

required

Set to true to acknowledge alarms, false to unacknowledge (remove acknowledgement).

actions

array of objects

required

length ≥ 1

List of alarm actions identifying which alarms to process. Must contain at least one item.

actions*

Identifies a specific alarm to perform an action on.

int64

Primary key ID of the alarm in the Orchestrator database.

sequenceId

int32

Sequence ID assigned by the appliance for alarms it generates.

source

string

Source identifier of the alarm (e.g., 'appliance').

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

Success - all alarms were acknowledged/unacknowledged successfully. No content returned.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Partial failure - some alarms could not be acknowledged. Returns error details for failed alarms.

400Bad Request - Invalid or missing nePk parameter.

404Not Found - The specified appliance does not exist.