v1

latestOpenAPI 3.0.1GNU AGPLv32026-07-174035592.6 KB
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