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

Capture comments for GMS alarms

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

Adds a comment or note to one or more active Orchestrator alarms identified by their IDs. Only active (non-closed) alarms can receive notes. HTML content is not allowed in notes for security reasons.

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

Object containing alarm IDs and the note to be captured

Request body for capturing notes on GMS alarms

ids
array of int32s
required
length ≥ 1

List of Orchestrator alarm IDs to add the note to. Must contain at least one ID. Only active (non-closed) alarms will be updated.

ids*

Unique alarm identifier from gmsalarm2 table

string
required
length ≥ 1

Comment or annotation to add to the alarms. Cannot be empty and must not contain HTML markup for security reasons.

Responses
204

Notes captured successfully. The comment has been added to all specified active alarms.

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ_WRITE permission

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

Did this page help you?