Get all alert definitions
query Parameters
namespaces | Array of strings |
services | Array of strings |
metrics | Array of strings |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 500
[- {
- "id": 0,
- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "templateId": 0,
- "notificationChannels": [
- "string"
]
}
]
Create a new alert definition
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the alert definition to be created
name required | string [ 1 .. 255 ] characters |
serviceName required | string [ 1 .. 255 ] characters |
serviceNamespace required | string [ 1 .. 255 ] characters |
metricName required | string [ 1 .. 255 ] characters |
description required | string <= 2000 characters |
detectionMethod required | string (AlertDetectionMethod) Enum: "METRIC" "ANOMALY" "INCIDENT" |
aggregationFunction required | string (AlertAggregationFunction) Enum: "SUM" "AVERAGE" "MAXIMUM" "MINIMUM" |
aggregationLabels required | Array of strings |
window | string <duration> |
required | Array of objects (AlertThreshold) non-empty |
enabled required | boolean |
notificationChannels required | Array of strings |
Responses
Request samples
- Payload
{- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "notificationChannels": [
- "string"
]
}
Response samples
- 201
- 400
- 401
- 500
1
Get alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 404
- 500
{- "id": 0,
- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "templateId": 0,
- "notificationChannels": [
- "string"
]
}
Update an existing alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
name required | string [ 1 .. 255 ] characters |
serviceName required | string [ 1 .. 255 ] characters |
serviceNamespace required | string [ 1 .. 255 ] characters |
metricName required | string [ 1 .. 255 ] characters |
description required | string <= 2000 characters |
detectionMethod required | string (AlertDetectionMethod) Enum: "METRIC" "ANOMALY" "INCIDENT" |
aggregationFunction required | string (AlertAggregationFunction) Enum: "SUM" "AVERAGE" "MAXIMUM" "MINIMUM" |
aggregationLabels required | Array of strings |
window | string <duration> |
required | Array of objects (AlertThreshold) non-empty |
enabled required | boolean |
notificationChannels required | Array of strings |
Responses
Request samples
- Payload
{- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "notificationChannels": [
- "string"
]
}
Response samples
- 400
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Remove an existing alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Patch an existing alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
enabled required | boolean |
Responses
Request samples
- Payload
{- "enabled": true
}
Response samples
- 400
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Create a new incident alert definition
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the alert definition to be created
name required | string [ 1 .. 255 ] characters |
type required | string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT" |
notificationChannels | Array of strings |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "INCIDENT",
- "notificationChannels": [
- "string"
]
}
Response samples
- 201
- 400
- 401
- 500
1
Update an existing incident alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
name required | string [ 1 .. 255 ] characters |
type required | string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT" |
notificationChannels | Array of strings |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "INCIDENT",
- "notificationChannels": [
- "string"
]
}
Response samples
- 400
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Remove an existing incident alert definition
path Parameters
id required | integer <int64> Alert definition identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Create a new notification channel
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the notification channel to be created
name required | string [ 1 .. 255 ] characters |
apiUrl required | string non-empty |
channel required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "recipients": [
- "string"
], - "apiUrl": "string",
- "channel": "string",
- "type": "SLACK"
}
Response samples
- 400
- 401
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Update an existing notification channel
path Parameters
name required | string Notification channel name |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
name required | string [ 1 .. 255 ] characters |
apiUrl required | string non-empty |
channel required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "recipients": [
- "string"
], - "apiUrl": "string",
- "channel": "string",
- "type": "SLACK"
}
Response samples
- 400
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Remove an existing notification channel
path Parameters
name required | string Notification channel name |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Create a new message template
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the message template to be created
name required | string [ 1 .. 255 ] characters |
template required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "template": "string"
}
Response samples
- 400
- 401
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Get message template by name
path Parameters
name required | string Message template name |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 404
- 500
{- "id": 0,
- "name": "string",
- "metricName": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "targetThreshold": 0,
- "timeWindow": "string",
- "warningThreshold": 0,
- "notificationChannels": [
- "string"
]
}
Update an existing message template
path Parameters
name required | string Message template name |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
name required | string [ 1 .. 255 ] characters |
template required | string non-empty |
Responses
Request samples
- Payload
{- "name": "string",
- "template": "string"
}
Response samples
- 400
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Remove an existing message template
path Parameters
name required | string Message template name |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}
Get all alert templates
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 403
- 500
[- {
- "id": 0,
- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "templateId": 0,
- "notificationChannels": [
- "string"
], - "applyToNewSites": true
}
]
Create a new alert template
query Parameters
applyToSites | Array of strings List of sites the new alert template should be applied to |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the alert template to be created
name required | string [ 1 .. 255 ] characters |
serviceName required | string [ 1 .. 255 ] characters |
serviceNamespace required | string [ 1 .. 255 ] characters |
metricName required | string [ 1 .. 255 ] characters |
description required | string <= 2000 characters |
detectionMethod required | string (AlertDetectionMethod) Enum: "METRIC" "ANOMALY" "INCIDENT" |
aggregationFunction required | string (AlertAggregationFunction) Enum: "SUM" "AVERAGE" "MAXIMUM" "MINIMUM" |
aggregationLabels required | Array of strings |
window | string <duration> |
required | Array of objects (AlertThreshold) non-empty |
enabled required | boolean |
notificationChannels required | Array of strings |
applyToNewSites required | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "notificationChannels": [
- "string"
], - "applyToNewSites": true
}
Response samples
- 201
- 400
- 401
- 403
- 500
1
Get alert template
path Parameters
id required | integer <int64> Alert template identifier |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "serviceName": "string",
- "serviceNamespace": "string",
- "metricName": "string",
- "description": "string",
- "detectionMethod": "METRIC",
- "aggregationFunction": "SUM",
- "aggregationLabels": [
- "string"
], - "window": "string",
- "thresholds": [
- {
- "severity": "WARNING",
- "value": 0,
- "operator": "EQUAL",
- "unit": "PERCENTAGE",
- "duration": "string"
}
], - "enabled": true,
- "templateId": 0,
- "notificationChannels": [
- "string"
], - "applyToNewSites": true
}
Remove an existing alert template
path Parameters
id required | integer <int64> Alert template identifier |
query Parameters
deleteRelatedDefinitions | boolean Default: false Flag that determines if all alert definitions related to the alert template should be deleted |
header Parameters
X-Scope-OrgID | string Scope header |
Api-Version | string API version |
Responses
Response samples
- 401
- 403
- 404
- 500
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}