Skip to main content

Alerting service (v1)

Download OpenAPI specification:Download

Alert templates

Get all alert templates

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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/json
required

JSON representation of the alert template to be created

name
required
string [ 1 .. 255 ] characters
serviceName
required
string <= 255 characters
serviceNamespace
required
string <= 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
boolean
Default: true
updatedAt
required
string <date-time>
notificationTemplates
required
Array of strings
notificationChannels
required
Array of strings
applyToNewSites
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ],
  • "applyToNewSites": true
}

Response samples

Content type
text/plain
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

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "templateId": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ],
  • "applyToNewSites": true
}

Update an existing alert template

path Parameters
id
required
integer <int64>

Alert template identifier

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
serviceName
required
string <= 255 characters
serviceNamespace
required
string <= 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
boolean
Default: true
updatedAt
required
string <date-time>
notificationTemplates
required
Array of strings
notificationChannels
required
Array of strings
applyToNewSites
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ],
  • "applyToNewSites": true
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

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

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Alerts

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

Content type
application/json
[
  • {
    }
]

Create a new alert definition

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the alert definition to be created

name
required
string [ 1 .. 255 ] characters
serviceName
required
string <= 255 characters
serviceNamespace
required
string <= 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
boolean
Default: true
updatedAt
required
string <date-time>
notificationTemplates
required
Array of strings
notificationChannels
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ]
}

Response samples

Content type
text/plain
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

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "templateId": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ]
}

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/json
required
name
required
string [ 1 .. 255 ] characters
serviceName
required
string <= 255 characters
serviceNamespace
required
string <= 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
boolean
Default: true
updatedAt
required
string <date-time>
notificationTemplates
required
Array of strings
notificationChannels
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "metricName": "string",
  • "description": "string",
  • "detectionMethod": "METRIC",
  • "aggregationFunction": "SUM",
  • "aggregationLabels": [
    ],
  • "window": "string",
  • "thresholds": [
    ],
  • "enabled": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationTemplates": [
    ],
  • "notificationChannels": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "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

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "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/json
required
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Get alert definition's notification templates

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

Content type
application/json
[
  • "string"
]

Add notification template to alert definition

path Parameters
id
required
integer <int64>

Alert definition identifier

name
required
string
header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Remove notification template from alert definition

path Parameters
id
required
integer <int64>

Alert definition identifier

name
required
string
header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Notification channels

Get all notification channels

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new notification channel

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the notification channel to be created

name
required
string [ 1 .. 255 ] characters
updatedAt
required
string <date-time>
apiUrl
required
string non-empty
channel
required
string non-empty

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "recipients": [
    ],
  • "apiUrl": "string",
  • "channel": "string",
  • "type": "SLACK"
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "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/json
required
name
required
string [ 1 .. 255 ] characters
updatedAt
required
string <date-time>
apiUrl
required
string non-empty
channel
required
string non-empty

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "recipients": [
    ],
  • "apiUrl": "string",
  • "channel": "string",
  • "type": "SLACK"
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "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

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Notification templates

Get all notification templates

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new notification template

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the notification template to be created

name
required
string [ 1 .. 255 ] characters
type
required
string (NotificationType)
Enum: "EMAIL" "SLACK"

Enum representing the possible notification types

template
required
string non-empty
updatedAt
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "EMAIL",
  • "template": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Get notification template by name

path Parameters
name
required
string

notification template name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "metricName": "string",
  • "serviceName": "string",
  • "serviceNamespace": "string",
  • "targetThreshold": 0,
  • "timeWindow": "string",
  • "warningThreshold": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationChannels": [
    ]
}

Update an existing notification template

path Parameters
name
required
string

notification template name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
type
required
string (NotificationType)
Enum: "EMAIL" "SLACK"

Enum representing the possible notification types

template
required
string non-empty
updatedAt
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "EMAIL",
  • "template": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Remove an existing notification template

path Parameters
name
required
string

notification template name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Summaries

Get all summaries

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new summary

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the summary to be created

cron
string <cron>
Default: "* * * * 1"
includeCurrentOpenIssues
boolean
Default: true
includeTotalIssues
boolean
Default: true
includeTotalResolvedIssues
boolean
Default: true
includeAverageIssueTime
boolean
Default: true
includeMetricsCount
boolean
Default: true
includeActiveAlertsCount
boolean
Default: true
includeCocoSummary
boolean
Default: true
includeCocoAdvice
boolean
Default: true
updatedAt
required
string <date-time>
notificationChannels
Array of strings

Responses

Request samples

Content type
application/json
{
  • "cron": "* * * * 1",
  • "includeCurrentOpenIssues": true,
  • "includeTotalIssues": true,
  • "includeTotalResolvedIssues": true,
  • "includeAverageIssueTime": true,
  • "includeMetricsCount": true,
  • "includeActiveAlertsCount": true,
  • "includeCocoSummary": true,
  • "includeCocoAdvice": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationChannels": [
    ]
}

Response samples

Content type
text/plain
1

Get summary by id

path Parameters
id
required
integer <int64>

summary identifier

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "cron": "* * * * 1",
  • "includeCurrentOpenIssues": true,
  • "includeTotalIssues": true,
  • "includeTotalResolvedIssues": true,
  • "includeAverageIssueTime": true,
  • "includeMetricsCount": true,
  • "includeActiveAlertsCount": true,
  • "includeCocoSummary": true,
  • "includeCocoAdvice": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationChannels": [
    ]
}

Update an existing summary

path Parameters
id
required
integer <int64>

Summary identifier

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required
cron
string <cron>
Default: "* * * * 1"
includeCurrentOpenIssues
boolean
Default: true
includeTotalIssues
boolean
Default: true
includeTotalResolvedIssues
boolean
Default: true
includeAverageIssueTime
boolean
Default: true
includeMetricsCount
boolean
Default: true
includeActiveAlertsCount
boolean
Default: true
includeCocoSummary
boolean
Default: true
includeCocoAdvice
boolean
Default: true
updatedAt
required
string <date-time>
notificationChannels
Array of strings

Responses

Request samples

Content type
application/json
{
  • "cron": "* * * * 1",
  • "includeCurrentOpenIssues": true,
  • "includeTotalIssues": true,
  • "includeTotalResolvedIssues": true,
  • "includeAverageIssueTime": true,
  • "includeMetricsCount": true,
  • "includeActiveAlertsCount": true,
  • "includeCocoSummary": true,
  • "includeCocoAdvice": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "notificationChannels": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Remove an existing summary

path Parameters
id
required
integer <int64>

Summary identifier

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}