NEnetxms
Alarms

Change alarm state

Changed on

Performs bulk operations on alarms (terminate, acknowledge, resolve)

post/alarms

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/alarms
  • Auth
    • HTTP basic
    • or API key in cookie session_handle
    • or API key in header Session-Id

Query parameters

command'terminate' | 'acknowledge' | 'sticky_acknowledge' | 'resolve' required

Command to execute

timeoutinteger

Timeout for sticky_acknowledge (seconds)

Request body

alarmsinteger[] required

Array of alarm IDs

timeoutinteger

Alternative to query parameter for sticky_acknowledge timeout

Response

Operation completed

Changes

  • 32f48ec94aecRevision changes
    • breaking

      the query request parameter command was restricted to a list of enum values

    • breaking

      the query request parameter command became required

    • breaking

      the request property became required

    • breaking

      the / request property format changed from no format to int64

    • info

      added the new optional request property

    • info

      added the new enum value acknowledge to the query request parameter command

    • info

      added the new enum value resolve to the query request parameter command

    • info

      added the new enum value sticky_acknowledge to the query request parameter command

    • info

      added the new enum value terminate to the query request parameter command

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 910d3ad08e09Revision changes
    • info

      api operation id changeAlarmState was added

    • info

      added the non-success response with the status