Sign in
alarms

Find all alarms

Get paginated list of alarms.

  • PERMISSIONS: api_alarm_read
get/alarms

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

Changed in 6 of the 52 revisions of this API.4214

  • 1c19dcf99fec13See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • ○

      added pagination.ListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed common.PaginatedListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property errors to the response with the 400 status

      response-optional-property-added

  • 24b4a346840a112See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 400

      response-body-type-changed

    • ●

      removed the optional property errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added common.PaginatedListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed pagination.ListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bb6f0434af1213See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • ○

      added pagination.ListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed common.PaginatedListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property errors to the response with the 400 status

      response-optional-property-added

  • 11e4d00f16e02See the full diff
    • ○

      added common.PaginatedListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed pagination.ListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

  • fb4f0c9642fd2See the full diff
    • ○

      added pagination.ListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed common.PaginatedListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

  • 10a1f7617754112See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 400

      response-body-type-changed

    • ●

      removed the optional property errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added common.PaginatedListResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed pagination.ListResponse from the response body allOf list for the response status 200

      response-body-all-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog