Alert Actions

Get available actions for specified alert.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Responses
200

list of alert actions

application/json
get
/alerts/{id}/actions
200

list of alert actions

Invoke a specific alert action.

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Body
alertActionIdstringOptional
connectorIdstringOptional
typestringOptional
namestringOptional
iconUrlstringOptional
Responses
post
/alerts/{id}/actions
201

the alert action result, validate the 'success' field

Get alert actions.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
sourcenumberOptional

alert source id

connectorstringOptional

connector id

start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of alert actions.

Default: 100
Responses
200

The filtered alert actions

application/json
get
/alert-actions
200

The filtered alert actions

Create a new alert action.

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Body
idstringOptional
connectorIdstringOptional
connectorTypestring · enumRequiredPossible values:
namestringRequired
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
triggerModestring · enumOptionalPossible values:
bidirectionalbooleanRead-onlyOptional
escalationEndedDelaySecnumber · max: 7200Optional

May only be used with triggerType 'alert-escalation-ended' selected

notResolvedDelaySecnumber · max: 7200Optional

May only be used with triggerType 'v-alert-not-resolved' selected

conditionsstringOptional

Defines an optional alert filter condition in ICL language. This is a code based implementation, more info on syntax: https://docs.ilert.com/rest-api/icl-ilert-condition-language. For block based configuration please use the web UI. Note: this field is an ?include, it will not appear in lists.

paramsone ofOptional
or
or
or
objectOptional
or
or
or
or
or
or
objectOptional
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200

The newly created alert action

application/json
post
/alert-actions
200

The newly created alert action

Get a specific alert action.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idstringRequired

entity ID

Query parameters
Responses
200

The requested alert action

application/json
get
/alert-actions/{id}
200

The requested alert action

Update the specific alert action. (note: type cannot be changed)

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idstringRequired

entity ID

Body
idstringOptional
connectorIdstringOptional
connectorTypestring · enumRequiredPossible values:
namestringRequired
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
triggerModestring · enumOptionalPossible values:
bidirectionalbooleanRead-onlyOptional
escalationEndedDelaySecnumber · max: 7200Optional

May only be used with triggerType 'alert-escalation-ended' selected

notResolvedDelaySecnumber · max: 7200Optional

May only be used with triggerType 'v-alert-not-resolved' selected

conditionsstringOptional

Defines an optional alert filter condition in ICL language. This is a code based implementation, more info on syntax: https://docs.ilert.com/rest-api/icl-ilert-condition-language. For block based configuration please use the web UI. Note: this field is an ?include, it will not appear in lists.

paramsone ofOptional
or
or
or
objectOptional
or
or
or
or
or
or
objectOptional
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200

The updated alert action

application/json
put
/alert-actions/{id}
200

The updated alert action

Remove a specific alert action.

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idstringRequired

entity ID

Responses
delete
/alert-actions/{id}
204

Empty body delete response

No content

Last updated

Was this helpful?