Cloud Services

DevOps Intelligence

Supported APIs
Published On Oct 17, 2024 - 1:24 PM

Supported APIs

Learn about all the APIs supported in DevOps Intelligence.
DevOps Intelligence supports the following APIs:
  • List all accounts
  • Add an account to a database
  • Get account details
  • Delete an account
  • Patch an account
  • Return the overall health status of accounts
  • Return the overall health of all sync processes
  • Tools integration using your APIs. For a guide on how to do this, go to: Private Tools.

List all accounts

Use the following command to use the API to list your accounts:
GET /config/accounts
Parameters:
Name
Description
offset integer (query)
Offset to start returning items from limit integer (query)
limit integer (query)
Maximum number of items to return
Sample response:
[
      {
        "accounts": [
          {
            "accesskeyId": "string",
            "archived": true,
            "id": "string",
            "isDeleted": true,
            "name": "string",
            "organization": "string",
            "region": "string",
            "secretkey": "string",
            "status": 0
          }
        ],
        "pagination": {
          "count": 0,
          "first": "string",
          "last": "string",
          "limit": 0,
          "next": "string",
          "offset": 0,
          "prev": "string",
          "total": 0
        }
      }
    ]

Add an account to a database

Use the following command to use the API to add an account to a database:
POST /config/accounts
The parameter for this API is the name of an account in the format shown in the following example:
{
      "accesskeyId": "string",
      "archived": true,
      "id": "string",
      "isDeleted": true,
      "name": "string",
      "organization": "string",
      "region": "string",
      "secretkey": "string",
      "status": 0
    }

Get the details of an account

Use the following command with the API to get the account details:
GET /config/accounts{account}
The parameter for this API is the name of an account in the format shown in the following example:
{
    "accesskeyId": "string",
    "archived": true,
    "id": "string",
    "isDeleted": true,
    "name": "string",
    "organization": "string",
    "region": "string",
    "secretkey": "string",
    "status": 0
    }

Deleting an account

Use the following command with the API to delete an account:
DELETE /config/accounts{account}
Sample response:
The request for account deletion is successfully processed

Patching an account

To patch an account, use the following command to call the API:
PATCH /config/accounts{account}
The required parameters are the name of the account and the patch in JSON format as shown in the following example:
{
    "accesskeyId": "string",
    "archived": true,
    "id": "string",
    "isDeleted": true,
    "name": "string",
    "organization": "string",
    "region": "string",
    "secretkey": "string",
    "status": 0
    }
Sample response:
patch will be successfully applied

Returning the overall health status of the accounts

GET /health/accounts
Sample response:
{
      "status": true,
      "total": 0,
      "unhealthyCount": 0
    }

Returning the overall health of all sync processes

GET /sync
Sample response:
{
      "_id": "string",
      "accountId": "string",
      "completed": "2019-08-19T21:11:02.067Z",
      "duration": 0,
      "name": "string",
      "recordsProcessed": 0,
      "started": "2019-08-19T21:11:02.067Z",
      "statusCode": 0,
      "subRecords": [
        {
          "completed": "2019-08-19T21:11:02.067Z",
          "duration": 0,
          "recordType": "string",
          "recordsProcessed": 0,
          "started": "2019-08-19T21:11:02.067Z",
          "statusCode": 0
        }
      ]
    }
Do you have two minutes for a quick survey?
Take Survey