Known Issue API Overview

Known Issues are faults, defects, or availability-related issues in Google Cloud or Amazon Web Services that may be impacting the performance or availability of your applications. You can access known issues on the Known Issues page, accessible via the left-hand navigation bar in the CMP as described here

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 with an easy-to-use RESTful API.

πŸ‘

API Reference

The Known Issues API reference is available at https://developer.doit-intl.com/reference/known-issues

πŸ“˜

Required Permissions

No permission is required to access Known Issues API

Known Issues API has the following methods:

knownIssues.list

The knownIssues.list method provides a list of all historical and active Known Issues as explained in Manage Known Issues section.

You can filter the list by using one or more of the following parameters:

Parameter

Description

minCreationTime

string
Min value for a Known Issue's creation time, in milliseconds since the POSIX epoch. If set, only Known Issues created after or at this timestamp are returned.

maxCreationTime

string
Max value for a Known Issue's creation time, in milliseconds since the POSIX epoch. If set, only Known Issues created before or at this timestamp are returned.

filter

string
An expression for filtering the results of the request. The syntax is key:[<value>]. For example, the platforms:google-cloud will filter the list to include only Google Cloud related Known Issues.

Supported filter keys:

  • product - one of the Google Cloud or AWS products
  • platform - can be 'google-cloud' or 'amazon-web-services'
  • status - can be 'active' or 'archived'

Learn more about how to properly use filter *.list requests

Sample knownIssues.list Request to list all active Known Issues for Google Cloud:

curl --location --request GET 'https://api.doit-intl.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-key

Always replace "your-api-key" with your actual API key as explained at Getting 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"
        }
    ]
}

knownIssues.get

Gets the full details of the individual Known Issue using the issue id. Please note, the issue id is not the same id as reported by the cloud provider.

Sample knownIssues.get Request

curl --location --request GET 'https://api.doit-intl.com/core/v1/knownissues/wByTuKs4Oo2MHHzLwHCA' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer your-api-key' \
--data-raw ''

πŸ“˜

your-api-key

Always replace "your-api-key" with your actual API key as explained at Getting Started

Sample knownIssues.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 Known Issue

{
    "id": string,
    "date": number,
    "platform": string,
    "product": string,
    "title": string,
    "status": string,
    "summary": string,
    "symptoms": string,
    "workaroud": string
}

Response Body Fields

Field

Description

id

string
A Known Issue's unique identifier. Note, this is NOT the id provided by the cloud provider.

date

number
output only. The time when this known issue was updated last time, in milliseconds since the epoch.`

platform

string
The cloud provider for a Known Issue. Can be either google-cloud or amazon-web-services.

product

string
The product affected by this Known Issue. Some common examples are EC2 or Google BigQuery.

title

string
The title of the Known Issue, as reported by the cloud provider.

status

string
The status of the Known Issue. can be either active which means the known issue is still ongoing or archived for no longer active Known Issues.

summary

string
Short summary explaining the Known Issue as reported by the cloud vendor.

symptoms

string
Symptoms of the Known Issue, if reported by the cloud vendor.

workaround

string
Workaround for the Known Issue, if made available by the cloud vendor.


Did this page help you?