Platform

Company APIs

listCompanies

Retrieves a list of all companies accessible to the logged-in user.

get

/platform/v2/companies

Authorizations

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "companyName": "opsnow",
        "isMainCompany": "Y"
      }
    ]
  }
}

OK

listCompanyUsers

Retrieves a list of all users associated with a company.

get

/platform/v2/companies/{companyId}/users

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "email": "[e-mail]",
        "displayName": "John Doe",
        "masterCompanyId": "65dd4cbf-b412-4f83-8476-97a3f1e161b2",
        "createdDate": "2023-01-01T12:00:00.000Z",
        "userStatCd": "ACTIVATED",
        "userRole": "ADMIN",
        "masterUserRole": "OWNER",
        "enabled": true
      }
    ]
  }
}

OK

Cloud Account - AWS APIs

listAwsAccounts

Retrieves a list of AWS accounts associated with the specified company ID.

get

/platform/v2/companies/{companyId}/vendors/aws/accounts

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Query parameters

isAddReadyToStartboolean

Specifies whether additional Member Accounts can be registered when isAddReadyToStart is set to true.

Example: true

accountTypestring

The accountType parameter represents the type of AWS account, primarily used to distinguish between master and member accounts. In the AWS account structure, the master account is the root account of an AWS Organization, responsible for managing member accounts and consolidating billing. In contrast, member accounts are individual accounts that belong to the master account, each with its own resources and services. This parameter is used in API requests to specify whether to query for master accounts or member accounts. The acceptable values are master and member.

Example: master

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "accountId": "123456789012",
        "accountAlias": "AWS 1st DEV Infra Account",
        "accountType": "master",
        "isCostAvailable": "true",
        "isSpPurchaseAccount": true,
        "errorDescription": "Error occurred during stack creation. You can identify the cause of the error in AWS Console > CloudFormation > Events tab. Please take necessary actions and retry.",
        "createdDate": "2024-05-20T07:06:47.253Z",
        "updatedDate": "2024-05-20T07:06:47.253Z",
        "status": "healthy",
        "contractStatus": "SUBSCRIBED"
      }
    ]
  }
}

OK

getAwsAccount

Fetches detailed information for a specific AWS account using the provided company and account IDs.

get

/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringrequired

The unique identifier of the AWS account.

Example: 123456789012

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "accountId": "123456789012",
    "accountAlias": "AWS 1st DEV Infra Account",
    "accountType": "master",
    "managementAccountId": "987654321987",
    "roleArn": "arn:aws:iam::123456789012:role/role-name",
    "stackName": "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
    "stackTemplateVersion": "1.0",
    "curBucketName": "bucket-name",
    "curBucketRegion": "us-east-1",
    "curBucketPrefix": "cur",
    "createdDate": "2024-05-20T07:06:47.253Z",
    "updatedDate": "2024-05-20T07:06:47.253Z",
    "status": "healthy",
    "contractStatus": "us-east-1"
  }
}

OK

updateAwsAccount

Updates the information of an existing AWS account identified by company and account IDs.

put

/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringrequired

The unique identifier of the AWS account.

Example: 123456789012

Body

accountAliasstring

The alias of the AWS account, used for easy identification.

Example: AWS 1st DEV Infra Account

isCancelDeleteAccountboolean

Specifies whether to cancel the deletion of the AWS Account.

Example: true

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"accountAlias":"AWS 1st DEV Infra Account","isCancelDeleteAccount":true}'

200

400

404

200

{
  "status": "success",
  "data": {
    "accountId": "123456789012"
  }
}

OK

deleteAwsAccount

Removes an AWS account from the system using the specified company and account IDs.

delete

/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringrequired

The unique identifier of the AWS account.

Example: 123456789012

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "accountId": "123456789012"
  }
}

OK

getAwsAccountSavingsAmount

Retrieves savings amount information for a specified AWS account, using the given company and account IDs.

get

/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

accountIdstringrequired

The unique identifier of the AWS account.

Example: 123456789012

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "netSavings": "10000.7"
  }
}

OK

getAwsAccountSetup

Obtains the setup information for an AWS account linked to the given company ID.

get

/platform/v2/companies/{companyId}/vendors/aws/accounts/setup

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Query parameters

registrationTypestring · default: single

Used to determine how to register AWS accounts. If the value is 'single', it registers a single account. If the value is 'bulk', it provides information to register multiple accounts at once.

Example: single

excludeAccountsstring[]

When obtaining the information needed to register accounts, specify the accounts you want to exclude when selecting in bulk. Enter AWS account numbers separated by commas, and the information will be returned excluding these accounts. Example: '123456789012, 234567890123'.

Example: 123456789012, 234567890123

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/setup' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "stackCreateConsoleLink": "https://console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/create/review?templateURL=https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml&stackName=opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb&param_CostUsageReportBucketName=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb&param_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5&param_CrossLinkedAccountID=370166107047&param_Domain=opsnow360.io&param_Profile=us2&param_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639&param_ResourceId=d442326f-878e-4500-8f82-d7c868f275bb",
    "stackCreateCliCommand": "aws cloudformation create-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 --template-url https://s3-data-dev-cloudformation.s3.ap-northeast-2.amazonaws.com/v1.2/opsnow-template-v1.2.yml --parameters ParameterKey=CrossAccountExternalID,ParameterValue=ae06161e-8d5b-4c34-80c1-26f2cf00fff5 ParameterKey=CrossLinkedAccountID,ParameterValue=370166107047 ParameterKey=CostUsageReportBucketName,ParameterValue=opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb ParameterKey=Domain,ParameterValue=opsnow360.io ParameterKey=Profile,ParameterValue=us2 ParameterKey=UserId,ParameterValue=0a0f27a2-ae56-4a2f-8544-68ecb8674639 ParameterKey=ResourceId,ParameterValue=d442326f-878e-4500-8f82-d7c868f275bb --capabilities CAPABILITY_NAMED_IAM",
    "stackDeleteCliCommand": "aws cloudformation delete-stack-set --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 \\\\ && \\\\aws cloudformation delete-stack --stack-name opsnow-stack-d442326f-878e-4500-8f82-d7c868f275bb --region us-east-1 ",
    "stackName": "opsnow-stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
    "templateUrl": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "crossAccountExternalId": "ae06161e-8d5b-4c34-80c1-26f2cf00fff5",
    "crossLinkedAccountId": "123123123123",
    "costUsageReportBucketName": "opsnow-cur-d442326f-878e-4500-8f82-d7c868f275bb",
    "domain": "opsnow.io",
    "profile": "us2",
    "userId": "a6e1e5f8-924d-4a8f-9f78-61c0879c9243",
    "resourceId": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
    "organizationId": "f23a80d2-2077-4e0a-aa85-e7b08a379be7"
  }
}

OK

Cloud Account - Azure APIs

listAzureTenants

Retrieves a list of Azure tenants associated with the specified company ID.

get

/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
        "tenantAlias": "First Tenant",
        "tenantType": "PAY-AS-YOU-GO",
        "subscriptionCount": 5,
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z",
        "status": "healthy"
      }
    ]
  }
}

OK

createAzureTenant

Creates a new Azure tenant for the specified company ID.

post

/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

tenantAliasstringrequired

The alias name of the Azure tenant.

Example: First Tenant

applicationIdstringrequired

The applicationId is a unique identifier assigned to an application when it is registered in Azure Active Directory (AAD). This identifier is used to identify the application and authenticate it when communicating with other services or applications. It is often referred to as ClientId. For example, when the application sends an authentication request to AAD, it includes this applicationId to prove its identity.

Example: 993a65dd-691f-44f7-ba1d-21e7b4c60d38

clientSecretstringrequired

The clientSecret is a secret key generated when an application is registered in Azure Active Directory (AAD). This secret key is used along with the applicationId when the application makes an authentication request. If both pieces of information match, AAD verifies the legitimacy of the application. It is crucial to store and manage the clientSecret securely as it is sensitive information that can pose security risks if exposed.

Example: your-client-secret

tenantTypestringrequired

Represents the type of the tenant, primarily categorized based on the subscription model. Examples include EA (Enterprise Agreement), Pay-As-You-Go, CSP and Azure Plan. This provides information related to the billing plan used by the tenant.

Example: PAY-AS-YOU-GO

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

enrollmentNumberstring

The 'Enrollment Number' refers to a unique identifier assigned to an organization when they purchase Microsoft Azure services. This number is used to manage multiple subscriptions, track usage and costs for billing purposes, and oversee services and resources linked to a specific subscription. It allows organizations to efficiently manage and monitor their Azure services.

Example: 123456

primaryKeystring

In the context of an Azure Enterprise Agreement (EA) account, the PRIMARY_KEY is a unique key provided to the organization. This key is used to authenticate and access Azure services and resources associated with the EA account. It acts as a secure credential, allowing the organization to manage and monitor its Azure usage and billing.

Example: jwt-token-format

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"6a05a771-d671-440a-9d64-087df0c16d6a","tenantAlias":"First Tenant","applicationId":"993a65dd-691f-44f7-ba1d-21e7b4c60d38","clientSecret":"your-client-secret","tenantType":"PAY-AS-YOU-GO","enrollmentNumber":"123456","primaryKey":"jwt-token-format"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

OK

getAzureTenant

Obtains the details of a specific Azure tenant linked to the given company ID.

get

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "tenantAlias": "First Tenant",
    "tenantType": "PAY-AS-YOU-GO",
    "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
    "enrollmentNumber": "123456",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z",
    "status": "healthy"
  }
}

OK

updateAzureTenant

Updates the information of a specific Azure tenant associated with the given company ID.

put

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Body

tenantAliasstringrequired

The alias name of the Azure tenant.

Example: First Tenant

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"tenantAlias":"First Tenant"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95"
  }
}

OK

deleteAzureTenant

Deletes a specific Azure tenant linked to the specified company ID.

delete

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

OK

listAzureSubscriptions

Retrieves a list of Azure subscriptions associated with the specified tenant ID.

get

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
        "subscriptionAlias": "First Subscription",
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "status": "healthy"
      }
    ]
  }
}

OK

createAzureSubscription

Creates a new Azure subscription for the specified tenant ID.

post

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

Body

subscriptionIdstringrequired

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

subscriptionAliasstringrequired

The alias name of the Azure subscription.

Example: First Subscription

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"subscriptionId":"c925a595-81d2-470c-a8cd-f7bd56fa8e95","subscriptionAlias":"First Subscription"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

OK

getAzureSubscription

Obtains the details of a specific Azure subscription linked to the given tenant ID.

get

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringrequired

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "subscriptionAlias": "First Subscription",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z",
    "status": "healthy"
  }
}

OK

updateAzureSubscription

Updates the information of a specific Azure subscription associated with the given tenant ID.

put

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringrequired

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Body

subscriptionAliasstringrequired

The alias name of the Azure subscription.

Example: First Subscription

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"subscriptionAlias":"First Subscription"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

OK

deleteAzureSubscription

Deletes a specific Azure subscription linked to the specified tenant ID.

delete

/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

subscriptionIdstringrequired

A unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.

Example: c925a595-81d2-470c-a8cd-f7bd56fa8e95

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
    "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
  }
}

OK

listAzureRegistrableSubscriptions

List registrable Azure subscriptions for the specified tenant ID.

post

/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

tenantIdstringrequired

A unique identifier used to identify an Azure Active Directory (AAD) tenant. It is used to distinguish the tenant to which all the organization's Azure resources and services belong.

Example: 6a05a771-d671-440a-9d64-087df0c16d6a

applicationIdstringrequired

The applicationId is a unique identifier assigned to an application when it is registered in Azure Active Directory (AAD). This identifier is used to identify the application and authenticate it when communicating with other services or applications. It is often referred to as ClientId. For example, when the application sends an authentication request to AAD, it includes this applicationId to prove its identity.

Example: 993a65dd-691f-44f7-ba1d-21e7b4c60d38

clientSecretstringrequired

The clientSecret is a secret key generated when an application is registered in Azure Active Directory (AAD). This secret key is used along with the applicationId when the application makes an authentication request. If both pieces of information match, AAD verifies the legitimacy of the application. It is crucial to store and manage the clientSecret securely as it is sensitive information that can pose security risks if exposed.

Example: your-client-secret

tenantTypestringrequired

Represents the type of the tenant, primarily categorized based on the subscription model. Examples include EA (Enterprise Agreement), Pay-As-You-Go, CSP and Azure Plan. This provides information related to the billing plan used by the tenant.

Example: PAY-AS-YOU-GO

Pattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"6a05a771-d671-440a-9d64-087df0c16d6a","applicationId":"993a65dd-691f-44f7-ba1d-21e7b4c60d38","clientSecret":"your-client-secret","tenantType":"PAY-AS-YOU-GO"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
        "subscriptionAlias": "First Subscription",
        "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
        "status": "healthy"
      }
    ]
  }
}

OK

Cloud Account - GCP APIs

listGcpProjects

Retrieves a list of GCP projects with the given company ID.

get

/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "projectType": "BILLING",
        "companyName": "opsnow",
        "serviceAccountId": "106821279384347983826",
        "datasetId": "my_dataset",
        "bigqueryTableName": "users_table",
        "status": "active"
      }
    ]
  }
}

OK

createGcpProject

Creates a new gcp project for the specified company ID.

post

/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

serviceAccountIdstringrequired

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347983826

projectIdstringrequired

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: cloud-platform-1234

projectAliasstringrequired

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: My Cloud Project

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: my_dataset

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"serviceAccountId":"106821279384347983826","projectId":"cloud-platform-1234","projectAlias":"My Cloud Project","datasetId":"my_dataset"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

OK

getGcpProject

Retrieves detailed information about a specific GCP project linked to the given company ID and project ID.

get

/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringrequired

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: cloud-platform-1234

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234",
    "projectAlias": "My Cloud Project",
    "companyName": "opsnow",
    "serviceAccountId": "106821279384347983826",
    "projectType": "BILLING",
    "datasetId": "my_dataset",
    "bigQueryTableName": "users_table",
    "status": "active",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z"
  }
}

OK

updateGcpProject

Updates the information of a specific GCP project with the given project ID.

put

/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringrequired

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: cloud-platform-1234

Body

projectAliasstring

A user-friendly name or alias for a GCP project, used for easier identification and management.

Example: My Cloud Project

datasetIdstring

A unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.

Example: my_dataset

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"projectAlias":"My Cloud Project","datasetId":"my_dataset"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

OK

deleteGcpProject

Deletes a specific Gcp Project linked to the specified project ID.

delete

/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

projectIdstringrequired

A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.

Example: cloud-platform-1234

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "projectId": "cloud-platform-1234"
  }
}

OK

listGcpServiceAccounts

Retrieves a list of GCP service accounts with the given company ID.

get

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "serviceAccountId": "106821279384347983826",
        "serviceAccountAlias": "my-service-account",
        "serviceAccountEmail": "[e-mail]",
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z",
        "status": "healthy"
      }
    ]
  }
}

OK

createGcpServiceAccount

Creates a new gcp service account for the specified company ID.

post

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

Body

serviceAccountAliasstringrequired

The alias name of the GCP service account.

Example: my-service-account

serviceAccountKeystringrequired

A Base64-encoded string of the JSON key file containing the credentials for a GCP service account

Example: <Base64-encoded JSON key file string>

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"serviceAccountAlias":"my-service-account","serviceAccountKey":"<Base64-encoded JSON key file string>"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

OK

getGcpServiceAccount

Retrieves detailed information about a specific GCP service account and its associated project

get

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringrequired

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826",
    "serviceAccountAlias": "my-service-account",
    "serviceAccountProjectId": "cloud-platform-1234",
    "serviceAccountEmail": "[e-mail]",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z",
    "projects": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "companyName": "opsnow",
        "serviceAccountId": "106821279384347983826",
        "projectType": "BILLING",
        "datasetId": "my_dataset",
        "bigQueryTableName": "users_table",
        "status": "active",
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z"
      }
    ]
  }
}

OK

updateGcpServiceAccount

Updates the information of a specific GCP account associated with the given company ID.

put

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringrequired

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Body

serviceAccountAliasstringrequired

The alias name of the GCP service account.

Example: my-service-account

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"serviceAccountAlias":"my-service-account"}'

200

400

404

200

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

OK

deleteGcpServiceAccount

Deletes a specific Gcp Account linked to the specified company ID.

delete

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringrequired

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826"
  }
}

OK

listGcpServiceAccountProjects

Retrieves a list of GCP projects with the given Service Account ID.

get

/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects

Authorizations

Path parameters

companyIdstringrequired

The ID of the organization, obtainable through 'listCompanies'.

Example: f23a80d2-2077-4e0a-aa85-e7b08a379be7

serviceAccountIdstringrequired

A unique identifier used to identify a Google Cloud service account. It is used to distinguish the service account that interacts with Google Cloud resources and services.

Example: 106821279384347980000

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

404

200

{
  "status": "success",
  "data": {
    "list": [
      {
        "projectId": "cloud-platform-1234",
        "projectAlias": "My Cloud Project",
        "projectType": "BILLING",
        "companyName": "opsnow",
        "serviceAccountId": "106821279384347983826",
        "datasetId": "my_dataset",
        "bigqueryTableName": "users_table",
        "status": "active"
      }
    ]
  }
}

OK