alarms

Find all alarms

Changed on

Get paginated list of alarms.

  • PERMISSIONS: api_alarm_read
get/alarms

Request

  • Base URL
    /api/v4 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v4/alarms
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

active_columns[]string[]
filters[]string[]
categorystring
tagstring
correlationboolean
instruction_filter_type0 | 1 | 2

Possible instruction filter type values.

  • 0 - No instructions.
  • 1 - No instructions or not in progress.
  • 2 - Has instructions.
instruction_ids[]string[]
instruction_statuses[]integer[]

Possible instruction filter type values.

  • 0 - No instructions.
  • 1 - No instructions or not in progress.
  • 2 - Has instructions.
instruction_type0 | 1

Possible instruction type values.

  • 0 - Manual.
  • 1 - Auto.
openedboolean
time_fieldstring
tstartinteger
tstopinteger
alarm_patternstring
entity_patternstring
pbehavior_patternstring
with_linksboolean

Links are retrieved from external service so use carefully with big limit.

with_instructionsboolean

show assigned instructions and execution flags

with_declare_ticketsboolean

show assigned declare ticket rules

only_bookmarksboolean

show bookmarked alarms

with_dependenciesboolean

count connected services depends_count and impacts_count

with_tag_colorsboolean

retrieve tag colors

limitinteger

items per page

pageinteger

current page

searchstring

search query

sort'asc' | 'desc'

sort query

sort_bystring
multi_sort[]string[]
query_logboolean

show query log

Changes

  • 1c19dcf99fecRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

  • 24b4a346840aRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status