Platform

Company APIs

listCompanies

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

GEThttps://api.opsnow.io/platform/v2/companies

Authorization

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListCompaniesResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

listCompanyUsers

Retrieves a list of all users associated with a company.

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/users

Authorization

Path parameters

companyId*string

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

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListCompanyUsersResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/users', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Cloud Account - AWS APIs

listAwsAccounts

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts

Authorization

Path parameters

companyId*string

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

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

Query parameters

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAwsAccountsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "list": [
      {
        "accountId": "123456789012",
        "accountAlias": "AWS 1st DEV Infra Account",
        "accountType": "master",
        "isCostAvailable": "true",
        "status": "healthy",
        "contractStatus": "SUBSCRIBED",
        "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"
      }
    ]
  }
}

getAwsAccount

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

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

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

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "accountId": "123456789012",
    "accountAlias": "AWS 1st DEV Infra Account",
    "accountType": "master",
    "managementAccountId": "987654321987",
    "status": "healthy",
    "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",
    "contractStatus": "us-east-1",
    "createdDate": "2024-05-20T07:06:47.253Z",
    "updatedDate": "2024-05-20T07:06:47.253Z"
  }
}

updateAwsAccount

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

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

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

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

accountId*string

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAwsAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

deleteAwsAccount

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

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}

Authorization

Path parameters

companyId*string

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

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

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAwsAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

getAwsAccountSavingsAmount

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan

Authorization

Path parameters

companyId*string

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

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

accountId*string

The unique identifier of the AWS account.

Example: 123456789012

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountSavingsRecommendationResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

getAwsAccountSetup

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/setup

Authorization

Path parameters

companyId*string

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

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

Query parameters

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAwsAccountSetupResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/aws/accounts/setup', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

Cloud Account - Azure APIs

listAzureTenants

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

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

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureTenantsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

createAzureTenant

Creates a new Azure tenant for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants

Authorization

Path parameters

companyId*string

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

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

Body

tenantId*string

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"

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

applicationId*string

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"

clientSecret*string

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"

tenantType*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureTenantResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
      "clientSecret": "your-client-secret",
      "tenantAlias": "First Tenant",
      "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
      "tenantType": "PAY-AS-YOU-GO"
    }),
});
const data = await response.json();

Response

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

getAzureTenant

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureTenantResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "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",
    "status": "healthy",
    "createdDate": "2023-07-10T14:48:00.000Z",
    "updatedDate": "2023-07-10T14:48:00.000Z"
  }
}

updateAzureTenant

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

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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

tenantAlias*string

The alias name of the Azure tenant.

Example: "First Tenant"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureTenantResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenantAlias": "First Tenant"
    }),
});
const data = await response.json();

Response

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

deleteAzureTenant

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

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAzureTenantResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

listAzureSubscriptions

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureSubscriptionsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}

createAzureSubscription

Creates a new Azure subscription for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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

subscriptionId*string

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"

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateAzureSubscriptionResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subscriptionAlias": "First Subscription",
      "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95"
    }),
});
const data = await response.json();

Response

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

getAzureSubscription

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

subscriptionId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetAzureSubscriptionResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

updateAzureSubscription

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

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

subscriptionId*string

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

subscriptionAlias*string

The alias name of the Azure subscription.

Example: "First Subscription"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateAzureSubscriptionResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subscriptionAlias": "First Subscription"
    }),
});
const data = await response.json();

Response

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

deleteAzureSubscription

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

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}

Authorization

Path parameters

companyId*string

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

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

tenantId*string

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"

subscriptionId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteAzureSubscriptionResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

listAzureRegistrableSubscriptions

List registrable Azure subscriptions for the specified tenant ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions

Authorization

Path parameters

companyId*string

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

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

Body

tenantId*string

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"

applicationId*string

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

clientSecret*string

Example: "your-client-secret"

tenantType*string

Example: "PAY-AS-YOU-GO"

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListAzureRegistrableSubscriptionsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
      "clientSecret": "your-client-secret",
      "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
      "tenantType": "PAY-AS-YOU-GO"
    }),
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}

Cloud Account - GCP APIs

listGcpProjects

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

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

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}

createGcpProject

Creates a new gcp project for the specified company ID.

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects

Authorization

Path parameters

companyId*string

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

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

Body

serviceAccountId*string

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"

projectId*string

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

Example: "cloud-platform-1234"

projectAlias*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateGcpProjectResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectAlias": "My Cloud Project",
      "projectId": "cloud-platform-1234",
      "serviceAccountId": "106821279384347983826"
    }),
});
const data = await response.json();

Response

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

getGcpProject

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

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

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

projectId*string

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

Example: "cloud-platform-1234"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpProjectResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

updateGcpProject

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

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

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

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

projectId*string

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"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateGcpProjectResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

deleteGcpProject

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

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}

Authorization

Path parameters

companyId*string

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

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

projectId*string

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

Example: "cloud-platform-1234"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteGcpProjectResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

listGcpServiceAccounts

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorization

Path parameters

companyId*string

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

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpServiceAccountsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "list": [
      {
        "serviceAccountId": "106821279384347983826",
        "serviceAccountAlias": "my-service-account",
        "serviceAccountEmail": "my-service-account@my-project.iam.gserviceaccount.com",
        "status": "healthy",
        "createdDate": "2023-07-10T14:48:00.000Z",
        "updatedDate": "2023-07-10T14:48:00.000Z"
      }
    ]
  }
}

createGcpServiceAccount

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

POSThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts

Authorization

Path parameters

companyId*string

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

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

Body

serviceAccountAlias*string

The alias name of the GCP service account.

Example: "my-service-account"

serviceAccountKey*string

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

Example: "<Base64-encoded JSON key file string>"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataCreateGcpServiceAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceAccountAlias": "my-service-account",
      "serviceAccountKey": "<Base64-encoded JSON key file string>"
    }),
});
const data = await response.json();

Response

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

getGcpServiceAccount

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

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

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

serviceAccountId*string

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataGetGcpServiceAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "status": "success",
  "data": {
    "serviceAccountId": "106821279384347983826",
    "serviceAccountAlias": "my-service-account",
    "serviceAccountProjectId": "cloud-platform-1234",
    "serviceAccountEmail": "my-service-account@my-project.iam.gserviceaccount.com",
    "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"
      }
    ]
  }
}

updateGcpServiceAccount

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

PUThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

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

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

serviceAccountId*string

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

serviceAccountAlias*string

The alias name of the GCP service account.

Example: "my-service-account"

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataUpdateGcpServiceAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceAccountAlias": "my-service-account"
    }),
});
const data = await response.json();

Response

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

deleteGcpServiceAccount

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

DELETEhttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}

Authorization

Path parameters

companyId*string

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

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

serviceAccountId*string

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataDeleteGcpServiceAccountResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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

listGcpServiceAccountProjects

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

GEThttps://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects

Authorization

Path parameters

companyId*string

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

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

serviceAccountId*string

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

Response

Body

statusstring

The status attribute indicates the state of the request, with "success" meaning the request was processed successfully and "error" indicating an error occurred during processing.

Example: "success"

dataListGcpProjectsResponseModel (object)

Request

const response = await fetch('https://api.opsnow.io/platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "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"
      }
    ]
  }
}

PreviousAPI reference NextCost

Last updated 3 months ago