Alert Sources
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
the maximum number of results when paging through a list of alert sources.
50
the alert source object
GET /api/alert-sources HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the alert source object
[
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"integrationUrl": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"status": "PENDING",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1,
"name": "text",
"teams": [
{
"id": 1,
"name": "text"
}
],
"timezone": "Europe/Berlin",
"supportDays": {
"MONDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"TUESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"WEDNESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"THURSDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"FRIDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SATURDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SUNDAY": {
"start": "14:34:10",
"end": "14:34:10"
}
}
},
"bidirectional": true
}
]
ONE_ALERT_PER_EMAIL
Possible values: true
Defines an optional event 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional create alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional accept alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional resolve alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
The URI of the alert source will be included in the location header and the alert source will be included in the body.
POST /api/alert-sources HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1627
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1
},
"summaryTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"detailsTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"routingTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"linkTemplates": [
{
"text": "text",
"hrefTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
}
}
],
"priorityTemplate": {
"valueTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"mappings": [
{
"value": "text",
"priority": "LOW"
}
]
},
"eventFilter": "text",
"alertKeyTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"eventTypeFilterCreate": "text",
"eventTypeFilterAccept": "text",
"eventTypeFilterResolve": "text"
}
The URI of the alert source will be included in the location header and the alert source will be included in the body.
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"integrationUrl": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"status": "PENDING",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1,
"name": "text",
"teams": [
{
"id": 1,
"name": "text"
}
],
"timezone": "Europe/Berlin",
"supportDays": {
"MONDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"TUESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"WEDNESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"THURSDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"FRIDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SATURDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SUNDAY": {
"start": "14:34:10",
"end": "14:34:10"
}
}
},
"bidirectional": true,
"summaryTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"detailsTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"routingTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"linkTemplates": [
{
"text": "text",
"hrefTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
}
}
],
"priorityTemplate": {
"valueTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"mappings": [
{
"value": "text",
"priority": "LOW"
}
]
},
"eventFilter": "text",
"alertKeyTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"eventTypeFilterCreate": "text",
"eventTypeFilterAccept": "text",
"eventTypeFilterResolve": "text"
}
numeric source id or integration key
the alert source object
GET /api/alert-sources/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the alert source object
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"integrationUrl": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"status": "PENDING",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1,
"name": "text",
"teams": [
{
"id": 1,
"name": "text"
}
],
"timezone": "Europe/Berlin",
"supportDays": {
"MONDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"TUESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"WEDNESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"THURSDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"FRIDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SATURDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SUNDAY": {
"start": "14:34:10",
"end": "14:34:10"
}
}
},
"bidirectional": true,
"summaryTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"detailsTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"routingTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"linkTemplates": [
{
"text": "text",
"hrefTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
}
}
],
"priorityTemplate": {
"valueTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"mappings": [
{
"value": "text",
"priority": "LOW"
}
]
},
"eventFilter": "text",
"alertKeyTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"eventTypeFilterCreate": "text",
"eventTypeFilterAccept": "text",
"eventTypeFilterResolve": "text"
}
entity ID
ONE_ALERT_PER_EMAIL
Possible values: true
Defines an optional event 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional create alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional accept alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
Defines an optional resolve alert rule 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. It has no effect on manually created alerts. Note: this field is an ?include, it will not appear in lists.
the updated alert source object
PUT /api/alert-sources/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1627
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1
},
"summaryTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"detailsTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"routingTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"linkTemplates": [
{
"text": "text",
"hrefTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
}
}
],
"priorityTemplate": {
"valueTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"mappings": [
{
"value": "text",
"priority": "LOW"
}
]
},
"eventFilter": "text",
"alertKeyTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"eventTypeFilterCreate": "text",
"eventTypeFilterAccept": "text",
"eventTypeFilterResolve": "text"
}
the updated alert source object
{
"id": 1,
"teams": [
{
"id": 1,
"name": "text"
}
],
"name": "text",
"iconUrl": "text",
"lightIconUrl": "text",
"darkIconUrl": "text",
"escalationPolicy": {
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
},
"integrationType": "NAGIOS",
"integrationKey": "text",
"integrationUrl": "text",
"autoResolutionTimeout": "text",
"alertGroupingWindow": "text",
"alertCreation": "ONE_ALERT_PER_EMAIL",
"status": "PENDING",
"active": true,
"alertPriorityRule": "HIGH",
"supportHours": {
"id": 1,
"name": "text",
"teams": [
{
"id": 1,
"name": "text"
}
],
"timezone": "Europe/Berlin",
"supportDays": {
"MONDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"TUESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"WEDNESDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"THURSDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"FRIDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SATURDAY": {
"start": "14:34:10",
"end": "14:34:10"
},
"SUNDAY": {
"start": "14:34:10",
"end": "14:34:10"
}
}
},
"bidirectional": true,
"summaryTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"detailsTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"routingTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"linkTemplates": [
{
"text": "text",
"hrefTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
}
}
],
"priorityTemplate": {
"valueTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"mappings": [
{
"value": "text",
"priority": "LOW"
}
]
},
"eventFilter": "text",
"alertKeyTemplate": {
"textTemplate": "text",
"elements": [
{
"type": "TEXT",
"val": "text",
"func": "text",
"args": [
{
"S": "text",
"N": 1
}
]
}
]
},
"eventTypeFilterCreate": "text",
"eventTypeFilterAccept": "text",
"eventTypeFilterResolve": "text"
}
Was this helpful?