Cloud incidents API Overview
Cloud incidents are faults, defects, or availability-related issues in Google Cloud or Amazon Web Services that may affect the performance or availability of your applications.
The Known Issues API helps you programmatically obtain your DoiT International cloud provider Known Issues for supported assets such as Google Cloud or Amazon Web Services.
API ReferenceThe cloud incidents API reference is available at https://developer.doit.com/reference/listknownissues.
Required PermissionsNo permission is required to access Cloud incidents API
Cloud incidents API has the following methods:
knownIssues.list
The knownIssues.list method provides a list of all historical and active cloud incidents.
You can filter the list using the following parameters:
Parameter | Description |
---|---|
|
|
|
|
|
Supported filter keys:
|
Sample knownIssues.list Request to list all active
Known Issues for Google Cloud
:
curl --location --request GET 'https://api.doit.com/core/v1/knownissues?filter=status:active|platform:google-cloud' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--data-raw ''
YOUR_API_KEYReplace "YOUR_API_KEY" with your actual API key as explained at Get Started
Sample knownIssues.list Response:
{
"pageToken": "",
"knownIssues": [
{
"id": "NfSBW5YyXjEO3RWlSAC7",
"date": 1600886599000000,
"platform": "google-cloud",
"product": "Cloud Logging",
"title": "Google Cloud issue [ONGOING]: Cloud Logging - Alert #169253182",
"status": "active"
}
]
}
cloudincidents.get
Gets the full details of the individual incident using the issue ID. Note that the issue ID is not the one reported by the cloud provider.
Sample cloudincidents.get Request
curl --location --request GET 'https://api.doit.com/core/v1/cloudincidents/wByTuKs4Oo2MHHzLwHCA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer your-api-key' \
--data-raw ''
your-api-keyAlways replace "your-api-key" with your actual API key as explained at Getting Started
Sample cloudincidents.get Response:
{
"id": "wByTuKs4Oo2MHHzLwHCA",
"date": 1606648783,
"platform": "amazon-web-services",
"product": "Ec2",
"title": "Aws Ec2 Operational Issue",
"status": "archived",
"summary": "Network Connectivity",
"description": "[09:07 PM PST] Between 4:59 AM and 11:25 AM KST, a small number of instances experienced connectivity issues in a single Availability Zone in the AP-NORTHEAST-2 Region",
"symptoms": "",
"workaroud": ""
}
Response Body
If successful, the response body contains an instance of Cloud Incident
{
"id": string,
"date": number,
"platform": string,
"product": string,
"title": string,
"status": string,
"summary": string,
"symptoms": string,
"workaroud": string
}
Response Body Fields
Field | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Updated 11 days ago