Incidents service (v1)

Download OpenAPI specification:Download

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

CRUD

Get anomalies and incidents

query Parameters

startTimestamp	integer <int64> Start time in epoch seconds
endTimestamp	integer <int64> End time in epoch seconds
type	Array of strings (IncidentType) Items Enum: "INCIDENT" "ANOMALY" "ALERT" Type filter
status	Array of strings (IncidentStatus) Items Enum: "OPEN" "RESOLVED" Status filter
resolution	string Resolution filter
category	Array of strings (IncidentCategory) Items Enum: "PERFORMANCE" "RELIABILITY" "SECURITY" "CONFIGURATION" Category filter
service	Array of strings Service filter
namespace	Array of strings Namespace filter
metric	Array of strings Metric filter
source	Array of strings Source filter
acknowledged	boolean Acknowledged filter
cursor	string Paging cursor
direction	string (PagingCommand.Direction) Enum: "NEXT" "PREVIOUS" Paging direction
pageSize	integer [ 1 .. 100 ] Page size

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{ }
],
"paging": {"cursor": {"firstId": 0,
"lastId": 0
},
"hasNext": true,
"hasPrevious": true
}
}

Create or update an incident

header Parameters

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

Request Body schema: application/json
required

JSON representation of the incident

type required	string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT"
incidentId required	string <= 16 characters
title required	string <= 255 characters
category required	string (IncidentCategory) Enum: "PERFORMANCE" "RELIABILITY" "SECURITY" "CONFIGURATION"
description required	string <= 2000 characters
recommendation required	string <= 2000 characters
source required	string <= 255 characters
status required	string (IncidentStatus) Enum: "OPEN" "RESOLVED"
resolution required	string <= 20 characters
required	Array of objects (Incident.Service) non-empty
metricNames required	Array of strings
startTime	string <date-time> Either an ISO 8601 or second timestamp format
endTime	string <date-time> Either an ISO 8601 or second timestamp format
sourceSite required	string <= 50 characters
severity required	string <= 10 characters
priority required	string <= 10 characters
required	object

Responses

Request samples

Payload

Content type

application/json

{"type": "INCIDENT",
"incidentId": "string",
"title": "string",
"category": "PERFORMANCE",
"description": "string",
"recommendation": "string",
"source": "string",
"status": "OPEN",
"resolution": "string",
"services": [{"namespace": "string",
"name": "string"
}
],
"metricNames": ["string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"sourceSite": "string",
"severity": "string",
"priority": "string",
"metadata": { }
}

Response samples

200
208
400
401
500

Content type

text/plain

Get anomalies and incidents with facets

query Parameters

startTimestamp	integer <int64> >= 0 Start time in epoch seconds
endTimestamp	integer <int64> >= 0 End time in epoch seconds
type	Array of strings (IncidentType) Items Enum: "INCIDENT" "ANOMALY" "ALERT" Type filter
status	Array of strings (IncidentStatus) Items Enum: "OPEN" "RESOLVED" Status filter
resolution	string Resolution filter
category	Array of strings (IncidentCategory) Items Enum: "PERFORMANCE" "RELIABILITY" "SECURITY" "CONFIGURATION" Category filter
service	Array of strings Service filter
namespace	Array of strings Namespace filter
metric	Array of strings Metric filter
source	Array of strings Source filter
acknowledged	boolean Acknowledged filter
cursor	string Paging cursor
direction	string (PagingCommand.Direction) Enum: "NEXT" "PREVIOUS" Paging direction
limit	integer [ 1 .. 100 ] Maximum page size

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

{"data": [{"id": 0,
"type": "INCIDENT",
"incidentId": "string",
"title": "string",
"category": "PERFORMANCE",
"description": "string",
"recommendation": "string",
"source": "string",
"status": "OPEN",
"resolution": "string",
"services": [{"namespace": "string",
"name": "string"
}
],
"metricNames": ["string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"sourceSite": "string",
"severity": "string",
"priority": "string",
"metadata": { },
"ackTime": "2019-08-24T14:15:22Z",
"ackUserId": "string",
"ackUserEmail": "string"
}
],
"paging": {"cursor": {"firstId": 0,
"lastId": 0
},
"hasNext": true,
"hasPrevious": true
},
"facets": [{"id": "string",
"name": "string",
"values": [{"id": "string",
"name": "string",
"count": 0
}
]
}
]
}

Get anomaly or incident

path Parameters

id

required

integer <int64>

header Parameters

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

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": 0,
"type": "INCIDENT",
"incidentId": "string",
"title": "string",
"category": "PERFORMANCE",
"description": "string",
"recommendation": "string",
"source": "string",
"status": "OPEN",
"resolution": "string",
"services": [{"namespace": "string",
"name": "string"
}
],
"metricNames": ["string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"sourceSite": "string",
"severity": "string",
"priority": "string",
"metadata": { },
"ackTime": "2019-08-24T14:15:22Z",
"ackUserId": "string",
"ackUserEmail": "string"
}

Partially update an incident

path Parameters

id

required

integer <int64>

header Parameters

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

Request Body schema: application/json
required

JSON representation of the incident

title required	string <= 255 characters
description required	string <= 2000 characters
recommendation required	string <= 2000 characters
status required	string (IncidentStatus) Enum: "OPEN" "RESOLVED"
resolution required	string <= 20 characters
severity required	string <= 10 characters
priority required	string <= 10 characters

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"recommendation": "string",
"status": "OPEN",
"resolution": "string",
"severity": "string",
"priority": "string"
}

Response samples

200
208
400
401
500

Content type

application/json

{"id": 0,
"type": "INCIDENT",
"incidentId": "string",
"title": "string",
"category": "PERFORMANCE",
"description": "string",
"recommendation": "string",
"source": "string",
"status": "OPEN",
"resolution": "string",
"services": [{"namespace": "string",
"name": "string"
}
],
"metricNames": ["string"
],
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"sourceSite": "string",
"severity": "string",
"priority": "string",
"metadata": { },
"ackTime": "2019-08-24T14:15:22Z",
"ackUserId": "string",
"ackUserEmail": "string"
}

Statistics

Get the number of incidents grouped by type in buckets in the time frame. When status filter is set to RESOLVED it will count only resolved incidents at the given time range, otherwise counts OPEN incidents in the given time range

query Parameters

timestampFrom	integer <int64> >= 0 Timestamp from in epoch seconds
timestampTo	integer <int64> >= 0 Timestamp to in epoch seconds
type	string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT" Type filter
status	string (IncidentStatus) Enum: "OPEN" "RESOLVED" Status filter
resolution	string Resolution filter
buckets	integer <int32> >= 1 Default: 1 Number of buckets to returns

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

[{"bucket": 0,
"min": 0,
"max": 0,
"count": 0,
"groups": {"property1": 0,
"property2": 0
}
}
]

Get the number of current incidents

query Parameters

status required	string (IncidentStatus) Enum: "OPEN" "RESOLVED" Status filter
type	string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT" Type filter

header Parameters

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

Responses

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 the number of current incidents split by priority

query Parameters

status required	string (IncidentStatus) Enum: "OPEN" "RESOLVED" Status filter
type	string (IncidentType) Enum: "INCIDENT" "ANOMALY" "ALERT" Type filter

header Parameters

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

Responses

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 the number of opened incidents grouped by severity in buckets in the time frame.

query Parameters

timestampFrom	integer <int64> >= 0 Timestamp from in epoch seconds
timestampTo	integer <int64> >= 0 Timestamp to in epoch seconds
buckets	integer <int32> >= 1 Default: 1 Number of buckets to return

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

[{"bucket": 0,
"min": 0,
"max": 0,
"count": 0,
"groups": {"property1": 0,
"property2": 0
}
}
]

Get the number of incidents in the time frame

path Parameters

type

required

string (IncidentType)

Enum: "INCIDENT" "ANOMALY" "ALERT"

query Parameters

timestampFrom	integer <int64> >= 0 Start timestamp in epoch seconds
timestampTo	integer <int64> >= 0 End timestamp in epoch seconds

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

{"OPEN": 12,
"RESOLVED": 5
}

Get services with the most number of incidents

path Parameters

type

required

string (IncidentType)

Enum: "INCIDENT" "ANOMALY" "ALERT"

query Parameters

startTimestampFrom	integer <int64> >= 0 Start time from timestamp in epoch seconds
startTimestampTo	integer <int64> >= 0 Start time to timestamp in epoch seconds

header Parameters

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

Responses

Response samples

200
400
401
500

Content type

application/json

[{"namespace": "string",
"name": "string",
"counter": 0
}
]

Notes

Get incident note

path Parameters

noteId

required

integer <int64> >= 0

Note id

header Parameters

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

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"id": 0,
"incidentId": 0,
"body": "string",
"createdAt": "2019-08-24T14:15:22Z"
}

Update note

path Parameters

noteId

required

integer <int64> >= 0

Note id

header Parameters

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

Request Body schema: application/json
required

JSON representation of the incident note

body

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

{"body": "string"
}

Response samples

204
400
401
404
500

Content type

application/json

"CONTINUE"

Delete note

path Parameters

noteId

required

integer <int64> >= 0

Note id

header Parameters

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

Responses

Response samples

204
400
401
404
500

Content type

application/json

"CONTINUE"

Get incident notes

path Parameters

incidentId

required

integer <int64> >= 0

Incident id

header Parameters

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

Responses

Response samples

200
400
401
404
500

Content type

application/json

[{"id": 0,
"incidentId": 0,
"body": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]

Create note for incident

path Parameters

incidentId

required

integer <int64> >= 0

Incident id

header Parameters

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

Request Body schema: application/json
required

JSON representation of the incident note

body

required

string non-empty

Responses

Request samples

Payload

Content type

application/json

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

Scan reports

Get scan report from a 3rd party tool

query Parameters

source

required

string [ 1 .. 255 ] characters

header Parameters

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

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"source": "string",
"createdAt": "2019-08-24T14:15:22Z",
"payload": "string"
}

Store a scan report from a 3rd party tool

header Parameters

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

Request Body schema: application/json
required

JSON representation of the report

source required	string [ 1 .. 255 ] characters
createdAt required	string <date-time>
payload required	string

Responses

Request samples

Payload

Content type

application/json

{"source": "string",
"createdAt": "2019-08-24T14:15:22Z",
"payload": "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 cluster score as reported by the scanners

header Parameters

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

Responses

Response samples

200
401
404
500

Content type

application/json

{"score": 0,
"grade": "string"
}

Metadata

Get incident types

header Parameters

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

Responses

Response samples

200
401
500

Content type

application/json

"INCIDENT"

Operations

Acknowledge an incident

path Parameters

id

required

integer <int64>

header Parameters

X-Scope-OrgID	string Tenant header
User-ID	string Current user identifier
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"
}

Incidents service (v1)

CRUD

Get anomalies and incidents

query Parameters

header Parameters

Responses

Response samples

Create or update an incident

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get anomalies and incidents with facets

query Parameters

header Parameters

Responses

Response samples

Get anomaly or incident

path Parameters

header Parameters

Responses

Response samples

Partially update an incident

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Statistics

Get the number of incidents grouped by type in buckets in the time frame. When status filter is set to RESOLVED it will count only resolved incidents at the given time range, otherwise counts OPEN incidents in the given time range

query Parameters

header Parameters

Responses

Response samples

Get the number of current incidents

query Parameters

header Parameters

Responses

Response samples

Get the number of current incidents split by priority

query Parameters

header Parameters

Responses

Response samples

Get the number of opened incidents grouped by severity in buckets in the time frame.

query Parameters

header Parameters

Responses

Response samples

Get the number of incidents in the time frame

path Parameters

query Parameters

header Parameters

Responses

Response samples

Get services with the most number of incidents

path Parameters

query Parameters

header Parameters

Responses

Response samples

Notes

Get incident note

path Parameters

header Parameters

Responses

Response samples

Update note

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete note

path Parameters

header Parameters

Responses

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