Capture comments for appliance alarms

post

http://127.0.0.1:8080/alarm/note/appliance

Adds notes/comments to one or more active appliance alarms identified by their sequence IDs or primary keys. The note is stored in Orchestrator and optionally forwarded to the appliance if supported.

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

Object containing alarm identifiers and the note to add.

Request body for adding notes to appliance alarms.

actions

array of objects

required

length ≥ 1

List of alarm identifiers to add notes to. Must contain at least one alarm action.

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').

note

string

required

length ≥ 1

The comment/note text to add to the alarms. Cannot be empty and must not contain HTML tags.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

Notes successfully captured for all specified alarms.

Language

Loading…

Response

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

application/json

text/plain

text/html

200Partial success. Some alarms failed to capture notes. Returns details of failed alarms.

400Bad request. Occurs when nePk is missing/empty, actions array is empty, note is empty, or note contains HTML content.

404The specified appliance does not exist in the system.