Skip to main content
API docs by Redocly

Alerting service (v1)

Download OpenAPI specification:Download

Cobrick: aiops@cobrick.com URL: https://cobrick.com License: Commercial

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

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new alert definition

header Parameters
X-Scope-OrgID
string

Tenant 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 [ 1 .. 255 ] characters
serviceNamespace
required
string [ 1 .. 100 ] 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
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": [
    ],
  • "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

Tenant 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": [
    ],
  • "templateId": 0,
  • "notificationChannels": [
    ]
}

Update an existing alert definition

path Parameters
id
required
integer <int64>

Alert definition identifier

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
serviceName
required
string [ 1 .. 255 ] characters
serviceNamespace
required
string [ 1 .. 100 ] 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
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": [
    ],
  • "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

Tenant header

Api-Version
string

API version

Responses

Response samples

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

Functional alerts

Get all incident alert definitions

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new incident alert definition

header Parameters
X-Scope-OrgID
string

Tenant 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
type
required
string (IncidentType)
Enum: "INCIDENT" "ANOMALY" "ALERT"
notificationChannels
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "INCIDENT",
  • "notificationChannels": [
    ]
}

Response samples

Content type
text/plain
1

Update an existing incident alert definition

path Parameters
id
required
integer <int64>

Alert definition identifier

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
type
required
string (IncidentType)
Enum: "INCIDENT" "ANOMALY" "ALERT"
notificationChannels
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "INCIDENT",
  • "notificationChannels": [
    ]
}

Response samples

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

Tenant 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

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new notification channel

header Parameters
X-Scope-OrgID
string

Tenant 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
apiUrl
required
string non-empty
channel
required
string non-empty

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "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

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
apiUrl
required
string non-empty
channel
required
string non-empty

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "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

Tenant header

Api-Version
string

API version

Responses

Response samples

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

Message templates

Get all message templates

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new message template

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the message template to be created

name
required
string [ 1 .. 255 ] characters
template
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "template": "string"
}

Response samples

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

Tenant 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,
  • "notificationChannels": [
    ]
}

Update an existing message template

path Parameters
name
required
string

Message template name

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
template
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "template": "string"
}

Response samples

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

Tenant header

Api-Version
string

API version

Responses

Response samples

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

Alert templates

Get all alert templates

header Parameters
X-Scope-OrgID
string

Tenant 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

Tenant 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 [ 1 .. 255 ] characters
serviceNamespace
required
string [ 1 .. 100 ] 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
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": [
    ],
  • "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

Tenant 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": [
    ],
  • "templateId": 0,
  • "notificationChannels": [
    ],
  • "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

Tenant header

Api-Version
string

API version

Responses

Response samples

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