NEnetxms
Alarms

Get details of specific alarm

Changed on
get/v1/alarms/{alarm-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/alarms/{alarm-id}
  • Auth
    HTTP bearer

Path parameters

alarm-idinteger required

Response

Details of given alarm

idinteger

Alarm ID

parentIdinteger

Parent alarm ID (0 if none)

rcaScriptNamestring

Root cause analysis script name

ackByUserinteger

ID of the user who acknowledged the alarm

resolvedByUserinteger

ID of the user who resolved the alarm

terminatedByUserinteger

ID of the user who terminated the alarm

ruleGUIDstring uuid

GUID of the event processing policy rule that generated the alarm

ruleDescriptionstring

Description of the originating rule

eventCodeinteger

Source event code

eventNamestring

Source event name (present only when the event code resolves to a name)

eventIdinteger

Source event ID

eventTagsstring

Source event tags

sourceinteger

Source object ID

dciinteger

Related DCI ID (0 if none)

creationTimestring date-time

Alarm creation timestamp

lastChangeTimestring date-time

Last change timestamp

keystring

Alarm key

messagestring

Alarm message

impactstring

Business impact

stateinteger

Alarm state: 0=Outstanding, 1=Acknowledged, 2=Resolved, 3=Terminated

isStickyboolean

Whether the alarm is sticky

severityinteger

Current severity: 0=Normal, 1=Warning, 2=Minor, 3=Major, 4=Critical

originalSeverityinteger

Original severity at creation time

helpDeskStateinteger

Helpdesk integration state

repeatCountinteger

Number of times the alarm was repeated

subordinateAlarmsinteger[]

IDs of subordinate alarms

Changes

  • 47b14ef7aa72Revision changes
    • breaking

      the / response's property type changed from integer to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 30e75dc6a94cRevision changes
    • info

      added the media type application/json for the response with the status