Alerting service (v1)

Download OpenAPI specification:Download

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

Alert templates

Get all alert templates

header Parameters

X-Scope-OrgID	string Scope header
Api-Version	string API version

Responses

Response samples

200
401
403
500

Content type

application/json

[{"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/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
notificationChannels required	Array of strings
applyToNewSites required	boolean

Responses

Request samples

Payload

Content type

application/json

{"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

Content type

text/plain

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

Content type

application/json

{"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
}

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
notificationChannels required	Array of strings
applyToNewSites required	boolean

Responses

Request samples

Payload

Content type

application/json

{"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

400
401
404
500

Content type

application/json

{"_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 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

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"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

200
401
500

Content type

application/json

[{"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/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
notificationChannels required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"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

Content type

text/plain

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

Content type

application/json

{"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/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
notificationChannels required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"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

Content type

application/json

{"_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

Content type

application/json

{"_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/json
required

enabled

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

400
401
404
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"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

200
401
500

Content type

application/json

[{"name": "string",
"type": "EMAIL",
"recipients": ["string"
]
}
]

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

Responses

Request samples

Payload

Content type

application/json

Example

SLACK

{"name": "string",
"recipients": ["string"
],
"apiUrl": "string",
"channel": "string",
"type": "SLACK"
}

Response samples

400
401
500

Content type

application/json

{"_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/json
required

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

Responses

Request samples

Payload

Content type

application/json

Example

SLACK

{"name": "string",
"recipients": ["string"
],
"apiUrl": "string",
"channel": "string",
"type": "SLACK"
}

Response samples

400
401
404
500

Content type

application/json

{"_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
409
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"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

200
401
500

Content type

application/json

[{"name": "string",
"template": "string"
}
]

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
template required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"template": "string"
}

Response samples

400
401
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"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

200
401
404
500

Content type

application/json

{"id": 0,
"name": "string",
"metricName": "string",
"serviceName": "string",
"serviceNamespace": "string",
"targetThreshold": 0,
"timeWindow": "string",
"warningThreshold": 0,
"notificationChannels": ["string"
]
}

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
template required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"template": "string"
}

Response samples

400
401
404
500

Content type

application/json

{"_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 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

401
404
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Alerting service (v1)

Alert templates

Get all alert templates

header Parameters

Responses

Response samples

Create a new alert template

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get alert template

path Parameters

header Parameters

Responses

Response samples

Update an existing alert template

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove an existing alert template

path Parameters

query Parameters

header Parameters

Responses

Response samples

Alerts

Get all alert definitions

query Parameters

header Parameters

Responses

Response samples

Create a new alert definition

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get alert definition

path Parameters

header Parameters

Responses

Response samples

Update an existing alert definition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove an existing alert definition

path Parameters

header Parameters

Responses

Response samples

Patch an existing alert definition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Notification channels

Get all notification channels

header Parameters

Responses

Response samples

Create a new notification channel

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update an existing notification channel

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required