Retrieve all alarms or a subset using filter criteria

GET 
/alarm

Retrieve all alarms or a subset using filter criteria

Request

Query Parameters

realm string
status string

Possible values: [OPEN, ACKNOWLEDGED, IN_PROGRESS, RESOLVED, CLOSED]

assetId string
assigneeId string

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

Responses

default

default response

application/json

Schema

Schema

• Array [

idint64
realmstringrequired
titlestring
contentstring
severitystringrequired

Possible values: [LOW, MEDIUM, HIGH]

statusstringrequired

Possible values: [OPEN, ACKNOWLEDGED, IN_PROGRESS, RESOLVED, CLOSED]

sourcestringrequired

Possible values: [MANUAL, CLIENT, GLOBAL_RULESET, REALM_RULESET, ASSET_RULESET, AGENT]

sourceIdstring
sourceUsernamestring
createdOndate-time
acknowledgedOndate-time
lastModifieddate-time
assigneeIdstring
assigneeUsernamestring

asset

object[]

Array [

idstring

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

versionint64

createdOndate-time

namestringrequired

Possible values: non-empty and <= 1023 characters

accessPublicReadboolean

parentIdstring

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

realmstringrequired

Possible values: non-empty and <= 255 characters

typestring

pathstring[]

attributes

object

delegate

object

property name*

AttributeObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

timestampint64

property name*

AttributeObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

messagestring

typestringrequired

]

format

object

useGroupingboolean

minimumIntegerDigitsint32

minimumFractionDigitsint32

maximumFractionDigitsint32

minimumSignificantDigitsint32

maximumSignificantDigitsint32

asBooleanboolean

asDateboolean

asSliderboolean

resolutionnumber

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsint32

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

asNumberboolean

asOnOffboolean

asPressedReleasedboolean

asOpenClosedboolean

asMomentaryboolean

multilineboolean

unitsstring[]

arrayDimensionsint32

metaUseOnlyboolean

jsonTypestring

namestringrequired

Possible values: Value must match regular expression ^\w+$

timestampint64

]

• ]

Example (from schema)

[
  {
    "id": 0,
    "realm": "string",
    "title": "string",
    "content": "string",
    "severity": "LOW",
    "status": "OPEN",
    "source": "MANUAL",
    "sourceId": "string",
    "sourceUsername": "string",
    "createdOn": "2024-07-29T15:51:28.071Z",
    "acknowledgedOn": "2024-07-29T15:51:28.071Z",
    "lastModified": "2024-07-29T15:51:28.071Z",
    "assigneeId": "string",
    "assigneeUsername": "string",
    "asset": [
      {
        "id": "string",
        "version": 0,
        "createdOn": "2024-07-29T15:51:28.071Z",
        "name": "string",
        "accessPublicRead": true,
        "parentId": "string",
        "realm": "string",
        "type": "string",
        "path": [
          "string"
        ],
        "attributes": {
          "delegate": {}
        }
      }
    ]
  }
]