1 of 13

English

About

This document introduces the official API of opsnow.io

Why opsnow.io?

Cost Savings: Explore complex cloud costs and find cost-saving opportunities.
Resource Management: Ensure visibility and control over cloud resources. Monitor and manage resources to optimize your cloud environment.
Intuitive API: This document guides developers through powerful APIs to provide integrations and automations for cloud management. With clear instructions and examples, developers can easily and quickly leverage all the features of the opsnow.io platform.

We're delighted to have you here, and we're confident that our platform will drive efficiency, clarity, and scalability for your cloud operations.

Endpoint

Endpoints Overview

Domain

api.opsnow.io

Each service URL is composed with the hostname to form the endpoint of each API.

Service Endpoint

Platform

/platform

Purpose

The Platform endpoint focuses on the overall management of the opsnow.io service.

It encompasses a wide range of configuration tasks for the site, from user management to adjustments for various services.

Key Features

User Management: Add, modify, or remove users and assign roles and permissions.
Service Settings:Configure and adjust settings related to the opsnow.io service.
Insights with Platform Analytics: Understand user interactions, platform usage, and other essential metrics.

Resources

/asset

Purpose

The Resources endpoint is designed for the overall management of cloud resources. It provides services to users who want to track, update, or configure cloud resources.

Key Features

Resource List: Provides a list of in-use resources within the cloud.
Resource Details: Offers detailed information about a specific resource.
Resource Optimization: Allows the removal of unnecessary resources and optimization of the cloud environment..

Authentication

This article describes the authentication method of opsnow.io's API.

All requests to the API require authentication.

opsnow.io uses a Bearer token for this purpose. Include the token in the request header as follows:

Authorization: Bearer YOUR_TOKEN_HERE

For security reasons, keep the access token confidential.

Avoid hardcoding it directly into the application or exposing it in client-side scripts.

User Authentication Method

opsnow.io issues an API key after the user authentication process during the login. Subsequently, you can obtain an access token to make API calls.

Step 1. Request for API Key Issuance

The requested user information is verified, and an API Key will be issued.

Step 2. Request for Access Token Issuance

Using the API Key obtained in Step 1, request for access token issuance.
If the request for access token issuance is processed successfully, the access token and its expiration time (3600s) are returned.

curl -X POST "https://api.opsnow.io/platform/v2/identity/api-keys/token" \
-H "Content-Type: application/json" \
-d '{"apiKey":"YOUR_API_KEY"}'

Step 3. API Call

With the access token obtained in Step 2, you can use opsnow.io's actual API.
The issued access token follows the Bearer token method, explicitly stating the Bearer string and transmitting the access token.
If the access token's validity period expires, access token reissuance is necessary.

Errors

opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:

1. 2xx: Success

2. 4xx: Client Error

Indicates inaccurate or incomplete parameters.

code

description

400

Bad Request: Used when the client's request is malformed or invalid.

401

Unauthorized: Used when the client is not authenticated or when the authentication token has expired.

404

Not Found: Used when the requested resource is not present on the server.

405

Method Not Allowed: Used when attempting to access a resource with an unsupported HTTP method.

429

Too Many Requests: Used when the client has sent too many requests within a given time frame, typically indicating exceeding request limits.

3. 5xx: Server Error

Indicates that there is an error on the opsnow.io server.

code

description

500

Internal Server Error: Used when an internal server error occurs. Specific details about the cause should be checked in the server logs.

503

Service Unavailable: Used when the server is temporarily unable to handle the request. This could occur, for example, when the server is overloaded or undergoing maintenance.

504

Gateway Timeout: Used when the server, acting as a gateway or proxy, did not receive a timely response from the upstream server.

opsnow.io also outputs error messages and error codes in JSON format.

{
    "status": "fail",
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Rate Limiting

To ensure optimal performance and fairness, we provide rate limits.

Standard users can make a maximum of 1000 requests per hour.

If more access is required, please contact us at contact@opsnow.io to upgrade your limits.

API reference

API Reference

Welcome to api.opsnow.io API Reference. Our API is built with the purpose of streamlining cloud operations and is categorized into three main sections: asset, cost, and platform. Each of these endpoints is designed to offer developers a robust set of tools for seamless cloud management.

Platform

Company APIs

Cloud Account - AWS APIs

Cloud Account - Azure APIs

Cloud Account - GCP APIs

Cost

Anomaly History APIs

Anomaly Overview APIs

Anomaly Rules APIs

Cost Analytics APIs

Cost Analytics Filters APIs

Overview APIs

Resources

Common APIs

Elastic Search Filter APIs

Optimization Detail V3 APIs

Optimization Setting V3 APIs

Resource Optimization APIs

Resource Usage APIs

TagManager APIs

AutoSavings

AutoSavings Account APIs

Integrated(User & AutoSavings) Coverage APIs

Integrated(User & AutoSavings) Inventory APIs

Integrated(User & AutoSavings) Utilization APIs

Commitment

AWS Recommendation APIs

AWS Reserved Instance Inventory APIs

AWS Reserved Instance utilization APIs

AWS Savings Plans Inventory APIs

AWS Savings Plans utilization APIs

AWS commitment utilization APIs

Azure Recommendation APIs

GCP CUD(Committed Use Discount) Inventory APIs

GCP CUD(Committed Use Discount) utilization APIs

GCP Coverage APIs

GCP Recommendation APIs

Errors

opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:

1. 2xx: Success

2. 4xx: Client Error

Indicates inaccurate or incomplete parameters.

code

description

400

Bad Request: Used when the client's request is malformed or invalid.

401

Unauthorized: Used when the client is not authenticated or when the authentication token has expired.

404

Not Found: Used when the requested resource is not present on the server.

405

Method Not Allowed: Used when attempting to access a resource with an unsupported HTTP method.

429

Too Many Requests: Used when the client has sent too many requests within a given time frame, typically indicating exceeding request limits.

3. 5xx: Server Error

Indicates that there is an error on the opsnow.io server.

code

description

500

Internal Server Error: Used when an internal server error occurs. Specific details about the cause should be checked in the server logs.

503

Service Unavailable: Used when the server is temporarily unable to handle the request. This could occur, for example, when the server is overloaded or undergoing maintenance.

504

Gateway Timeout: Used when the server, acting as a gateway or proxy, did not receive a timely response from the upstream server.

opsnow.io also outputs error messages and error codes in JSON format.

{
    "status": "fail",
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Authentication

This article describes the authentication method of opsnow.io's API.

All requests to the API require authentication.

opsnow.io uses a Bearer token for this purpose. Include the token in the request header as follows:

Authorization: Bearer YOUR_TOKEN_HERE

For security reasons, keep the access token confidential.

Avoid hardcoding it directly into the application or exposing it in client-side scripts.

User Authentication Method

opsnow.io issues an API key after the user authentication process during the login. Subsequently, you can obtain an access token to make API calls.

Step 1. Request for API Key Issuance

Access the service and request the issuance of an API Key.
The requested user information is verified, and an API Key will be issued.

Step 2. Request for Access Token Issuance

Using the API Key obtained in Step 1, request for access token issuance.
If the request for access token issuance is processed successfully, the access token and its expiration time (3600s) are returned.

curl -X POST "https://api.opsnow.io/platform/v2/identity/api-keys/token" \
-H "Content-Type: application/json" \
-d '{"apiKey":"YOUR_API_KEY"}'

Step 3. API Call

With the access token obtained in Step 2, you can use opsnow.io's actual API.
The issued access token follows the Bearer token method, explicitly stating the Bearer string and transmitting the access token.
If the access token's validity period expires, access token reissuance is necessary.

Get AutoSavings account List

get

Retrieve information about the AWS account registered with the company.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

browserTimeZonestringOptional

Browser Timezone

Example: +09:00

linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'

linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'

accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstringOptional

roleArn

Example: 'roleArn'

accessKeystringOptional

secretKeystringOptional

tokenstringOptional

startDatestringOptional

endDatestringOptional

siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'

servicesstringOptional

AutoSavings services subscribed to by the account

Example: 'AUTO-RI, AUTO-STORAGE, AUTO-DISK

encryptKeystringOptional

subscriptionStatusstringOptional

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

200

*/*

get

200

Get AutoSavings Account Subscription Histories

get

Retrieve AWS AutoSavings subscription histories

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

browserTimeZonestringOptional

Browser Timezone

Example: +09:00

linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'

linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'

accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstringOptional

roleArn

Example: 'roleArn'

accessKeystringOptional

secretKeystringOptional

tokenstringOptional

startDatestringOptional

endDatestringOptional

siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'

servicesstringOptional

AutoSavings services subscribed to by the account

Example: 'AUTO-RI, AUTO-STORAGE, AUTO-DISK

encryptKeystringOptional

subscriptionStatusstringOptional

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

latestbooleanOptional

View the latest subscription information by account

Default: true

Responses

200

*/*

get

200

Get AutoSavings Account State

get

Retrieve registered AWS AutoSavings accounts state

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

browserTimeZonestringOptional

Browser Timezone

Example: +09:00

linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'

linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'

accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstringOptional

roleArn

Example: 'roleArn'

accessKeystringOptional

secretKeystringOptional

tokenstringOptional

startDatestringOptional

endDatestringOptional

siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'

servicesstringOptional

AutoSavings services subscribed to by the account

Example: 'AUTO-RI, AUTO-STORAGE, AUTO-DISK

encryptKeystringOptional

subscriptionStatusstringOptional

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

200

*/*

get

200

Get AutoSavings account AWS role ARN Info

get

Retrieve the necessary information for AWS cross-account registration.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

browserTimeZonestringOptional

Browser Timezone

Example: +09:00

linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'

linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'

accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstringOptional

roleArn

Example: 'roleArn'

accessKeystringOptional

secretKeystringOptional

tokenstringOptional

startDatestringOptional

endDatestringOptional

siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'

servicesstringOptional

AutoSavings services subscribed to by the account

Example: 'AUTO-RI, AUTO-STORAGE, AUTO-DISK

encryptKeystringOptional

subscriptionStatusstringOptional

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

200

*/*

get

200

Get AutoSavings Site Region

get

Retrieve Information about customer sites utilizing AWS AutoSavings.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

browserTimeZonestringOptional

Browser Timezone

Example: +09:00

linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'

linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'

accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '

roleArnstringOptional

roleArn

Example: 'roleArn'

accessKeystringOptional

secretKeystringOptional

tokenstringOptional

startDatestringOptional

endDatestringOptional

siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'

servicesstringOptional

AutoSavings services subscribed to by the account

Example: 'AUTO-RI, AUTO-STORAGE, AUTO-DISK

encryptKeystringOptional

subscriptionStatusstringOptional

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'

Responses

200

*/*

get

200

Get Savings Plans List

get

Get Coverage List

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings

commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

200

*/*

get

200

Get Savings Plans Filter

get

Get Coverage Filter

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings

commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

200

*/*

get

200

Get Savings Plans total summary

get

Get Coverage Total summary

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings

commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance

Responses

200

*/*

get

200

Get My Inventory List

get

Get My Inventory List

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get Savings Plans Inventory List

get

Get Savings Plans Inventory List

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get AutoSavings Inventory List

get

Get AutoSavings Inventory List

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get Agreement Utilization List

get

Get Agreement Utilization List

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get Total Transition

get

Get Utilization Total Transition

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get Filter

get

Get Utilization Filter

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

Get total summary

get

Get Utilization Total summary

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2023-10-01

endDatestringRequired

End Date

Example: 2023-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

regionsstringOptional

Regions

Example: [ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]

instanceTypesstringOptional

Instance types

Example: [ 't2.micro', 'm4.xlarge' ]

opsnowProductCodesstringOptional

OpsNow RI Purchase types

Example: [ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]

searchTypestringOptional

Search type

Example: All, My, AutoSavings

Responses

200

*/*

get

200

View list of resource optimization settings conditions

get

View the list of conditions that can be set according to resources by optimization category. If there are no conditions set, the default conditions are searched. Depending on the optimization type, resource type may be required.

Authorizations

Path parameters

cmpnIdstringRequired

Company Id

Example: 1

vendorstring · enumRequired

Vendor

Possible values:

optimizeCategorystring · enumRequired

Optimization category

Possible values:

ruleSetIdstringRequired

Rule id

Query parameters

resourceTypestringOptional

Resource type

Example: ec2

Responses

200

*/*

get

GET /asset/us-v1/optimization/setting/companies/{cmpnId}/vendors/{vendor}/optimize-category/{optimizeCategory}/rule-sets/{ruleSetId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

listAwsAccounts

get

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

Authorizations

Path parameters

companyIdstringRequired

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

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

Query parameters

isAddReadyToStartbooleanOptional

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

Example: true

accountTypestringOptional

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

getAwsAccountSetup

get

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

Authorizations

Path parameters

companyIdstringRequired

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

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

Query parameters

registrationTypestringOptional

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.

Default: singleExample: single

excludeAccountsstring[]Optional

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/aws/accounts/setup HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

getAzureSubscription

get

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

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

getGcpServiceAccount

get

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

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

get

GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Anomaly detection history detailed total daily grid list

post

View ai/manual abnormal cost detection daily grid data

Authorizations

Path parameters

analyzeTypestringRequired

Analyze Type

Example: ai

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

histSeqinteger · int32Required

History Seq

Example: 0

ruleSeqinteger · int32Required

Anomaly Rule Seq

Example: 0

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/history/detail/{analyzeType}/grid HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "histSeq": 0,
  "ruleSeq": 0
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Trend of anomaly detection by AI

post

View the trend of cost anomalies detected by AI.

Authorizations

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringRequired

vendor

Example: AWS

sensitivitystringRequired

Sensitivity

Example: M

forecastDtstringOptional

Forecast Date

Example: 2024-06-02

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/vendors/{vendor}/detections/ai/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "sensitivity": "M",
  "forecastDt": "2024-06-02"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Cost trend of cloud usage

post

View the cost trend of cloud usage.

Authorizations

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

vendorsstring[]Optional

List of vendors

selectedVendorsByWidgetstring[]Required

Selected Vendors by Widget

Example: ["AWS"]

viewTypestringRequired

View Type

Example: account

widgetTypestringRequired

Component Type

Example: dashboard_compare_cost_trend_widget

dateTypestringOptional

Widget Date Type

Example: monthly

dataTypestringOptional

Widget Date Type (etc. monthly, weekly, daily)

Example: monthly, weekly, daily

timeFramestringRequired

Time Frame

Example: last_3_months

viewBystringRequired

View By(account,product,region)

Example: account

filterstringOptional

Filter Type(top_10_by_cost / custom)

Example: top_10_by_cost

selectedAccountstringOptional

Selected Account Filter

Example: 000000000000

selectedAccountsstring[]Optional

Selected Accounts Filter

itemstring[]Optional

Selected Items Filter

selectedTagKeystringOptional

Selected Tag Key Filter

Example: Name

selectedServiceGroupSetstringOptional

Selected Service Group Set Filter

Example: 00000000-0000-0000-0000-000000000000

widgetCurrencynumber · doubleOptional

Widget Selected Currency

sensitivitystringOptional

Sensitivity value for a specific widget

Example: M

analyzedDtstringOptional

Analysis date

Example: 2024-06-02

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/vendors/{vendor}/dashboard/trend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 694

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "vendors": [
    "text"
  ],
  "selectedVendorsByWidget": [
    "AWS"
  ],
  "viewType": "account",
  "widgetType": "dashboard_compare_cost_trend_widget",
  "dateType": "monthly",
  "dataType": "monthly, weekly, daily",
  "timeFrame": "last_3_months",
  "viewBy": "account",
  "filter": "top_10_by_cost",
  "customFilter": [
    {
      "vendor": "text",
      "item": "text"
    }
  ],
  "selectedAccount": "000000000000",
  "selectedAccounts": [
    "text"
  ],
  "item": [
    "text"
  ],
  "selectedTagKey": "Name",
  "selectedServiceGroupSet": "00000000-0000-0000-0000-000000000000",
  "widgetCurrency": 1,
  "sensitivity": "M",
  "analyzedDt": "2024-06-02"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Potential anomalous usage data detected by AI

post

View the usage data that may lead to ai-predicted anomalous costs

Authorizations

Path parameters

vendorstringRequired

Vendor

Example: AWS

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

selectedVendorsByWidgetstring[]Required

Selected Vendors by Widget

Example: ["AWS","GCP"]

sensitivitystringRequired

Sensitivity

Example: M

forecastDatestringRequired

Forecast Date

Example: 2024-09-23

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/vendors/{vendor}/anomaly/aiPossibleCause HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "selectedVendorsByWidget": [
    "AWS",
    "GCP"
  ],
  "sensitivity": "M",
  "forecastDate": "2024-09-23"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Create/Update an anomaly detection rule setting

put

Create or update the setting of anomaly detection rule.

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

seqinteger · int32Optional

Anomaly Rule Seq

Example: 0

namestringOptional

Anomaly Rule Name

Example: Name

analyzeTypestringRequired

Abnormal Cost AI/Manual Type

Example: manual

analyzeBystringRequired

Abnormal Cost Analysis Type

Example: account

sensitivitystringRequired

Sensitivity

Example: M

thValnumber · doubleOptional

Threshold value

Example: 1

thOptstringOptional

Threshold detection options(percentage/amount)

Example: percentage

alertStatusstringOptional

Alarm Setting Status(active/inactive)

Example: inactive

alertFreqstringOptional

Alarm Frequency(daily, weekly)

Example: daily

alertOptstringOptional

Alarm Option(only, all)

Example: only

receiversstringOptional

Alarm recipients

useYnstringOptional

Alarm Enabled

Example: Y

forecastDtstringOptional

Forecast Date

Example: 2024-06-02

analyzedDtstringOptional

Analysis date

Example: 2024-06-02

viewBystringOptional

View By

Example: account

Responses

200

*/*

put

PUT /cost/v3/billing/anomaly/vendors/detections/alerts/rule/setting HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 442

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "seq": 0,
  "name": "Name",
  "analyzeType": "manual",
  "analyzeBy": "account",
  "sensitivity": "M",
  "thVal": 1,
  "thOpt": "percentage",
  "alertStatus": "inactive",
  "alertFreq": "daily",
  "alertOpt": "only",
  "receivers": "text",
  "useYn": "Y",
  "forecastDt": "2024-06-02",
  "analyzedDt": "2024-06-02",
  "viewBy": "account"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Anomaly detection rules

post

View the rules for detecting anomalies and sending alerts.

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Specific anomaly detection rule

post

View the specific rule for detecting anomalies and sending alerts.

Authorizations

Path parameters

seqinteger · int32Required

Rule Seq

Example: 0

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

seqinteger · int32Optional

Anomaly Rule Seq

Example: 0

Responses

200

*/*

post

POST /cost/v3/billing/anomaly/vendors/detections/alerts/rule/{seq} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "seq": 0
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Detail of cost analytics

post

View detailed portion chart data of cost analytics

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

selectedVendorstringRequiredExample: AWS

costDatestringRequiredExample: 2019-08-12

startDatestringRequiredExample: 2023-02-01

endDatestringRequiredExample: 2024-02-12

viewBystringRequiredExample: account

viewByIdstringOptional

viewByItemstringRequiredExample: 216093335544

itemViewIdstringRequiredExample: 216093335544

visibleFieldsstring[]Required

VisibleFields of detail grid

Example: ["vendor","linkedAccountId","productName","region","usage","cost","usageType"]

isMonthlybooleanRequiredExample: false

Responses

200

*/*

post

POST /cost/v3/billing/analytics/daily-portion HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2043

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "selectedVendor": "AWS",
  "costDate": "2019-08-12",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "viewBy": "account",
  "viewById": "text",
  "viewByItem": "216093335544",
  "itemViewId": "216093335544",
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "detailFilters": {
    "linkedAccountId": [
      "text"
    ],
    "productCode": [
      "text"
    ],
    "region": [
      "text"
    ],
    "usageType": [
      "text"
    ]
  },
  "visibleFields": [
    "vendor",
    "linkedAccountId",
    "productName",
    "region",
    "usage",
    "cost",
    "usageType"
  ],
  "tags": [
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ],
  "isMonthly": false
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Detail of cost analytics

post

View detailed grid of cost analytics

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

selectedVendorstringRequiredExample: AWS

costDatestringRequiredExample: 2019-08-12

startDatestringRequiredExample: 2023-02-01

endDatestringRequiredExample: 2024-02-12

viewBystringRequiredExample: account

viewByIdstringOptional

viewByItemstringRequiredExample: 216093335544

itemViewIdstringRequiredExample: 216093335544

visibleFieldsstring[]Required

VisibleFields of detail grid

Example: ["vendor","linkedAccountId","productName","region","usage","cost","usageType"]

isMonthlybooleanRequiredExample: false

Responses

200

*/*

post

POST /cost/v3/billing/analytics/daily-cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2043

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "selectedVendor": "AWS",
  "costDate": "2019-08-12",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "viewBy": "account",
  "viewById": "text",
  "viewByItem": "216093335544",
  "itemViewId": "216093335544",
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "detailFilters": {
    "linkedAccountId": [
      "text"
    ],
    "productCode": [
      "text"
    ],
    "region": [
      "text"
    ],
    "usageType": [
      "text"
    ]
  },
  "visibleFields": [
    "vendor",
    "linkedAccountId",
    "productName",
    "region",
    "usage",
    "cost",
    "usageType"
  ],
  "tags": [
    {
      "tagKey": "text",
      "tagValue": "text"
    }
  ],
  "isMonthly": false
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Summary of cost analytics

post

View summary of cost analytics

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

startDatestringRequired

start date

Example: 2023-02-01

endDatestringRequired

end date

Example: 2024-02-12

itemsPerPageinteger · int64Required

items per page

Example: 30

pageinteger · int64Required

page number

Example: 1

userNamestringOptional

user name

Example: abcd

viewBystringRequired

view by

Example: account

selectedVendorsstring[]Required

selected vendors

Example: ["AWS"]

isMonthlybooleanRequired

monthly

Example: false

Responses

200

*/*

post

POST /cost/v3/billing/analytics/cost HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1746

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "startDate": "2023-02-01",
  "endDate": "2024-02-12",
  "itemsPerPage": 30,
  "page": 1,
  "userName": "abcd",
  "viewBy": "account",
  "selectedVendors": [
    "AWS"
  ],
  "filters": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "isMonthly": false
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

post

View Cost Analytics filter

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

startDatestringRequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDatestringRequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewBystringOptional

View By

Example: account

fieldstringOptional

Filter query category

Example: platform

selectedKeystringOptional

Selected Key

Example: test

searchTextstringOptional

Search Text

Example: test

selectedVendorsstring[]Required

selected vendors

Example: ["AWS"]

Responses

200

*/*

post

POST /cost/v3/billing/analytics/related HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1746

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Filter of Cost Analytics

post

View Cost Analytics filter

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

startDatestringRequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDatestringRequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewBystringOptional

View By

Example: account

fieldstringOptional

Filter query category

Example: platform

selectedKeystringOptional

Selected Key

Example: test

searchTextstringOptional

Search Text

Example: test

selectedVendorsstring[]Required

selected vendors

Example: ["AWS"]

Responses

200

*/*

post

POST /cost/v3/billing/analytics/filter HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1746

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Category of cost analytics

post

View Category of cost analytics

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

userIdstringOptional

user id

Example: abcd

startDatestringRequired

Cost Analytics inquiry start date

Example: 2024-09-01

endDatestringRequired

Cost Analytics inquiry end date

Example: 2024-09-30

viewBystringOptional

View By

Example: account

fieldstringOptional

Filter query category

Example: platform

selectedKeystringOptional

Selected Key

Example: test

searchTextstringOptional

Search Text

Example: test

selectedVendorsstring[]Required

selected vendors

Example: ["AWS"]

Responses

200

*/*

post

POST /cost/v3/billing/analytics/filter/category HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1746

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "userId": "abcd",
  "conditions": {
    "aws": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "instanceType": [
        "text"
      ],
      "instanceTypeFamily": [
        "text"
      ],
      "chargeType": [
        "text"
      ],
      "os": [
        "text"
      ],
      "database": [
        "text"
      ],
      "transferType": [
        "text"
      ],
      "purchaseOption": [
        "text"
      ],
      "apiOperation": [
        "text"
      ],
      "resourceId": [
        "text"
      ],
      "usageType": [
        "text"
      ],
      "invoiceId": [
        "text"
      ],
      "itemDescription": [
        "text"
      ],
      "cacheEngine": [
        "text"
      ],
      "availabilityZone": [
        "text"
      ],
      "platform": [
        "text"
      ]
    },
    "azure": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ],
      "subscriptionNm": [
        "text"
      ],
      "subscriptionId": [
        "text"
      ],
      "infraType": [
        "text"
      ],
      "mtCategory": [
        "text"
      ],
      "mtName": [
        "text"
      ],
      "usage": [
        "text"
      ],
      "unitPrice": [
        "text"
      ],
      "totalCost": [
        "text"
      ]
    },
    "gcp": {
      "linkedAccountId": [
        "text"
      ],
      "productCode": [
        "text"
      ],
      "region": [
        "text"
      ],
      "productFamily": [
        "text"
      ],
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "serviceGroup": [
        {
          "serviceGroupKey": "text",
          "serviceGroupValue": "text",
          "serviceGroupSetNm": "text",
          "serviceGroupSetId": "text",
          "serviceGroupNm": "text",
          "serviceGroupId": "text",
          "dfltYn": "text"
        }
      ]
    }
  },
  "startDate": "2024-09-01",
  "endDate": "2024-09-30",
  "viewBy": "account",
  "field": "platform",
  "selectedKey": "test",
  "searchText": "test",
  "selectedVendors": [
    "AWS"
  ]
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Cloud cost overview

post

View cloud costs from the previous period and the estimated costs for the current month.

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

selectedVendorstringRequired

selected Vendor

Example: AWS

endDatestringOptional

The last date to include in the data range (inclusive). If not provided, defaults to the UTC current date.

Responses

200

*/*

post

POST /cost/v3/billing/overview/spend HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS",
  "selectedVendor": "AWS",
  "endDate": "text"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Latest cost collection date

post

View the latest cloud costs collection date of each vendor.

Authorizations

Body

siteCodestringRequired

site code

Example: BESPIN

companyIdstringRequired

company id

Example: 1

companyNamestringOptional

company name

Example: 1

defaultVendorstringRequired

default vendor

Example: AWS

userEmailstringOptional

user email

Example: abcd@bespingloba.com

userIdstringOptional

user id

Example: abcd

userNamestringOptional

user name

Example: abcd

vendorstringOptional

vendor

Example: AWS

Responses

200

*/*

post

POST /cost/v3/billing/overview/companyMaxDate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "siteCode": "BESPIN",
  "companyId": "1",
  "companyName": "1",
  "defaultVendor": "AWS",
  "userEmail": "abcd@bespingloba.com",
  "userId": "abcd",
  "userName": "abcd",
  "vendor": "AWS"
}

200

{
  "status": "success",
  "error": {
    "code": "OK",
    "message": "Error Message"
  }
}

Authorizations

Path parameters

menustringRequired

Example: usage

vendorstringRequired

vendor

Example: aws

viewTypestringRequired

view type

Example: history

Body

cmpnIdstringRequired

Company id

Example: 1

rsrcTypestringOptional

Resource Type

Example: ec2

vendorstringOptional

Vendor

Example: aws

viewTypestringOptional

View Type(current, history)

Example: history

menustringOptional

Example: usage

Responses

200

*/*

post

POST /asset/us-v1/{menu}/{vendor}/grid-headers/{viewType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "cmpnId": "1",
  "rsrcType": "ec2",
  "vendor": "aws",
  "viewType": "history",
  "menu": "usage"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Filter Data Quick Search For Usage

put

View Filter Data Quick Search For Usage

Authorizations

Path parameters

menuIdstringRequired

Menu Id

Example: usage

Body

cmpnIdstringRequired

Company id

Example: 1

actionTypestringRequired

Action Type(current, history)

Example: current

Responses

200

*/*

put

PUT /asset/us-v1/elastic/filter/{menuId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "cmpnId": "1",
  "actionType": "current",
  "keyList": [
    {
      "vndr": "aws",
      "key": "vendors",
      "value": "aws",
      "selectYn": "enabled"
    }
  ]
}

200

{
  "result": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test",
        "isRequired": true
      }
    ],
    "tagGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Grid View

post

Grid detail data inquiry according to optimization category and resource type

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequiredPossible values:

accountIdstringRequiredExample: 000000000000

regionIdstringRequiredExample: ap-northeast-2

instanceIdstringRequiredExample: vol-00000

resourceTypestringRequiredExample: ebs

vendorstring · enumRequiredExample: awsPossible values:

recommendstringRequiredExample: idle

Responses

200

*/*

post

POST /asset/us-v1/optimization/detail/list/info HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "cmpnId": "1",
  "optimizeCategory": "right-sizing",
  "accountId": "000000000000",
  "regionId": "ap-northeast-2",
  "instanceId": "vol-00000",
  "resourceType": "ebs",
  "vendor": "aws",
  "recommend": "idle"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Grid View

post

Grid data inquiry according to optimization category and resource type

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

*/*

post

POST /asset/us-v1/optimization/detail/list HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "cmpnId": "1",
  "optimizeCategory": "right-sizing",
  "resourceType": "ec2",
  "vendor": "aws",
  "accountList": [
    "text"
  ],
  "regionList": [
    "text"
  ],
  "serviceGroupList": [
    "text"
  ],
  "tagList": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ]
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Optimization Chart View

post

View optimization charts by optimization category and resource type

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

*/*

post

POST /asset/us-v1/optimization/detail/chart HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "cmpnId": "1",
  "optimizeCategory": "right-sizing",
  "resourceType": "ec2",
  "vendor": "aws",
  "accountList": [
    "text"
  ],
  "regionList": [
    "text"
  ],
  "serviceGroupList": [
    "text"
  ],
  "tagList": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ]
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Reset resource optimization settings conditions

put

Reset the optimization setting conditions for each resource by optimization category.

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumRequired

Vendor

Possible values:

resourceTypestringRequired

Resource Type

Example: ec2

optimizeCategorystring · enumRequired

Optimization category

Example: right-sizingPossible values:

Responses

200

*/*

put

PUT /asset/us-v1/optimization/setting/reset HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "cmpnId": "1",
  "vendor": "aws",
  "resourceType": "ec2",
  "optimizeCategory": "right-sizing"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Last optimization date lookup

post

Queries the last time resource optimization was performed.

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

*/*

post

POST /asset/us-v1/optimization/summary/last-execute HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "cmpnId": "1",
  "optimizeCategory": "right-sizing",
  "resourceType": "ec2",
  "vendor": "aws",
  "accountList": [
    "text"
  ],
  "regionList": [
    "text"
  ],
  "serviceGroupList": [
    "text"
  ],
  "tagList": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ]
}

200

{
  "data": {
    "lastExecuteDate": "2025-05-09T05:15:22.544Z"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View top card area by optimization category

post

Search the top card area data for each optimization category.

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

*/*

post

POST /asset/us-v1/optimization/summary/card HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "cmpnId": "1",
  "optimizeCategory": "right-sizing",
  "resourceType": "ec2",
  "vendor": "aws",
  "accountList": [
    "text"
  ],
  "regionList": [
    "text"
  ],
  "serviceGroupList": [
    "text"
  ],
  "tagList": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ]
}

200

{
  "data": [
    {
      "resourceType": "text",
      "expectedSavingCost": 1,
      "expectedSavingCount": 1
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage History Grid Data

post

View History Usage Grid Data

Authorizations

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

cmpnIdstringRequired

Company id

Example: 1

limitCntinteger · int32 · min: 1Optional

Page Limit Count

Example: 1

pageNuminteger · int32 · min: 1Optional

Page Number Count

Example: 1

offsetinteger · int32Optional

Page Offset

Example: 1

totalCntinteger · int32Optional

Page Total Count

Example: 1

fromstringRequired

From Date

Example: 2024-09-11

tostringRequired

To Date

Example: 2024-09-25

sortColIdstringRequired

Sort Column ID

Example: histDt

sortDirectionstringRequired

Sort Direction

Example: desc

excelYnstringRequired

Whether to download Excel

Example: N

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

isGetHeaderstringOptional

Header or not

Example: Y

viewTypestringRequired

View Type(hour, day, week, month)

Example: day

langCdstringOptional

Language Code

Example: en

hasHistoryViewbooleanOptional

Whether to check history or not

Example: true

searchTextstringOptional

Search Text

Example: test

fieldListstring[]Optional

Field List

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

Responses

200

*/*

post

POST /asset/us-v1/usage/{prvrCd}/grid/history HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 402

{
  "cmpnId": "1",
  "limitCnt": 1,
  "pageNum": 1,
  "offset": 1,
  "totalCnt": 1,
  "from": "2024-09-11",
  "to": "2024-09-25",
  "sortColId": "histDt",
  "sortDirection": "desc",
  "excelYn": "N",
  "rsrcType": "ec2",
  "prvrCd": "aws",
  "isGetHeader": "Y",
  "viewType": "day",
  "langCd": "en",
  "hasHistoryView": true,
  "searchText": "test",
  "fieldList": [
    "text"
  ],
  "regions": [
    "text"
  ],
  "svcGrps": [
    "text"
  ],
  "accounts": [
    "text"
  ],
  "tags": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ]
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Grid Data

post

View Current Usage Grid Data

Authorizations

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

cmpnIdstringRequired

Company id

Example: 1

rgnIdstringOptional

Region Id

Example: ap-northeast-2

limitCntinteger · int32Optional

Page Limit Count

Example: 1

pageNuminteger · int32Optional

Page Number Count

Example: 1

offsetinteger · int32Optional

Page Offset

Example: 1

totalCntinteger · int32Optional

Page Total Count

Example: 1

sortColIdstringOptional

Sort Column ID

Example: seq

sortDirectionstringOptional

Sort Direction

Example: desc

excelYnstringOptional

Whether to download Excel

Example: N

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

viewTypestringOptional

View Type(hour, day, week, month)

Example: day

fromstringOptional

From Date

Example: 2024-09-11

tostringOptional

To Date

Example: 2024-09-25

searchTextstringOptional

Search Text

Example: test

isGetHeaderstringOptional

Header or not

Example: Y

fieldListstring[]Optional

Field List

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

svcGrpViewstringOptional

Service Group View Id

Example: Default

langCdstringOptional

Language Code

Example: en

rsrcSeqstringOptional

Resource Seq

Example: 0

headerTypestringOptional

Header Type

Example: single

isResourcestringOptional

Resource or Not

Example: N

rsrcNmstringOptional

Resource Name

Example: test

hasHistoryViewbooleanOptional

Whether to check history or not

Example: true

delChkstringOptional

Whether to exclude deleted resources

Example: Y

Responses

200

*/*

post

POST /asset/us-v1/usage/{prvrCd}/grid/current HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 529

{
  "cmpnId": "1",
  "rgnId": "ap-northeast-2",
  "limitCnt": 1,
  "pageNum": 1,
  "offset": 1,
  "totalCnt": 1,
  "sortColId": "seq",
  "sortDirection": "desc",
  "excelYn": "N",
  "rsrcType": "ec2",
  "prvrCd": "aws",
  "viewType": "day",
  "from": "2024-09-11",
  "to": "2024-09-25",
  "searchText": "test",
  "isGetHeader": "Y",
  "fieldList": [
    "text"
  ],
  "regions": [
    "text"
  ],
  "svcGrps": [
    "text"
  ],
  "accounts": [
    "text"
  ],
  "tags": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ],
  "svcGrpView": "Default",
  "langCd": "en",
  "rsrcSeq": "0",
  "headerType": "single",
  "isResource": "N",
  "rsrcNm": "test",
  "hasHistoryView": true,
  "delChk": "Y"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage Current Chart Data

post

View Current Usage Chart Data

Authorizations

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

cmpnIdstringRequired

Company id

Example: 1

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

rsrcNmstringOptional

Resource Name

Example: test

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

reqTypestringOptional

delChkstringOptional

Whether to exclude deleted resources

Example: Y

Responses

200

*/*

post

POST /asset/us-v1/usage/{prvrCd}/chart/pie/current HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "cmpnId": "1",
  "rsrcType": "ec2",
  "prvrCd": "aws",
  "rsrcNm": "test",
  "regions": [
    "text"
  ],
  "svcGrps": [
    "text"
  ],
  "accounts": [
    "text"
  ],
  "tags": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ],
  "reqType": "text",
  "delChk": "Y"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Usage History Chart Data

post

View History Usage Chart Data

Authorizations

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

cmpnIdstringRequired

Company id

Example: 1

fromstringRequired

From Date

Example: 2024-09-11

tostringRequired

To Date

Example: 2024-09-25

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

viewTypestringRequired

View Type(hour, day, week, month)

Example: day

Responses

200

*/*

post

POST /asset/us-v1/usage/{prvrCd}/chart/history HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "cmpnId": "1",
  "from": "2024-09-11",
  "to": "2024-09-25",
  "rsrcType": "ec2",
  "prvrCd": "aws",
  "regions": [
    "text"
  ],
  "svcGrps": [
    "text"
  ],
  "accounts": [
    "text"
  ],
  "tags": [
    {
      "key": "Name",
      "value": [
        "text"
      ]
    }
  ],
  "viewType": "day"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Tag modification tasks (addition, deletion, and modification)

post

Authorizations

Body

cmpnIdstringRequired

Company id

Example: 1

updateTypestringOptional

replacementValuestringOptional

userEmailstringOptional

vendorstring · enumOptionalPossible values:

Responses

200

*/*

post

POST /asset/us-v1/tag-manager/update-tag HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "cmpnId": "1",
  "updateType": "text",
  "tagList": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-05-09T05:15:22.544Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "resourceList": [
    {
      "accId": "text",
      "rgnId": "text",
      "rsrcType": "text",
      "instId": "text",
      "arn": "text",
      "resourceGroupTaggingYn": "text",
      "existTags": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "sbscId": "text",
      "rsrcGrp": "text",
      "id": "text",
      "nrn": "text"
    }
  ],
  "replacementValue": "text",
  "userEmail": "text",
  "vendor": "aws"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Get tags

post

Authorizations

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

tagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

noValueYnstringOptional

tagYnstringOptional

Responses

200

*/*

post

POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tags HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-05-09T05:15:22.544Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "noValueYn": "text",
  "tagYn": "text"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Get resources

post

Authorizations

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

tagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

noValueYnstringOptional

tagYnstringOptional

Responses

200

*/*

post

POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-05-09T05:15:22.544Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "noValueYn": "text",
  "tagYn": "text"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Get resources by tags

post

Authorizations

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

tagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

noValueYnstringOptional

tagYnstringOptional

Responses

200

*/*

post

POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources-by-tags HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-05-09T05:15:22.544Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "noValueYn": "text",
  "tagYn": "text"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Get tagGroups

post

Authorizations

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

tagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

noValueYnstringOptional

tagYnstringOptional

Responses

200

*/*

post

POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 659

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-05-09T05:15:22.544Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "noValueYn": "text",
  "tagYn": "text"
}

200

{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

createAzureTenant

post

Creates a new Azure tenant for the specified company ID.

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-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

enrollmentNumberstringOptional

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

primaryKeystringOptional

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 260

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

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

createAzureSubscription

post

Creates a new Azure subscription for the specified tenant ID.

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
  "subscriptionAlias": "First Subscription"
}

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

updateAzureSubscription

put

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

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

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions/{subscriptionId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "subscriptionAlias": "First Subscription"
}

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

listAzureRegistrableSubscriptions

post

List registrable Azure subscriptions for the specified tenant ID.

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

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

clientSecretstringRequired

Example: your-client-secret

tenantTypestringRequired

Example: PAY-AS-YOU-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSP

Responses

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/azure/tenants/registrable-subscriptions HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
  "applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
  "clientSecret": "your-client-secret",
  "tenantType": "PAY-AS-YOU-GO"
}

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

createGcpProject

post

Creates a new gcp project for the specified company ID.

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

datasetIdstringOptional

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

Example: my_dataset

Responses

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

post

POST /platform/v2/companies/{companyId}/vendors/gcp/projects HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "serviceAccountId": "106821279384347983826",
  "projectId": "cloud-platform-1234",
  "projectAlias": "My Cloud Project",
  "datasetId": "my_dataset"
}

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

updateGcpProject

put

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

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

projectAliasstringOptional

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

Example: My Cloud Project

datasetIdstringOptional

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

Example: my_dataset

Responses

200

*/*

400

Bad Request

403

Forbidden

404

Not Found

put

PUT /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "projectAlias": "My Cloud Project",
  "datasetId": "my_dataset"
}

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

Get result list of AWS commitment recommendation

get

Retrieve results of AWS commitment recommendation

Authorizations

Path parameters

companyIdstringRequired

Company ID

servicestringRequired

Query parameters

productstringRequired

Recommendation target product

purchasestringRequired

Service

termstringRequired

Analysis terms

Example: 14

linkedAccountsstringOptional

Linked accounts

purchaseOptionstringOptional

Purchase option

leasContractLengthstringOptional

Commitment terms

offerClassstringOptional

Offer Class

analyzeTypeCodestringOptional

Savings Plan analysis type code

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": [
    {
      "accountId": "123456789012",
      "accountAlias": "Bespinglobal Platform",
      "product": "c4.xlarge",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "operationCode": "text",
      "os": "Linux/UNIX",
      "region": "ap-northeast-2",
      "instanceType": "c4.xlarge",
      "familyType": "c4",
      "savingsPlanType": "text",
      "analyzeTypeCode": "text",
      "analyzeTypeName": "text",
      "paymentOptions": "All Upfront",
      "termLength": "1yr",
      "offerClass": "standard",
      "flexibility": "Flexible",
      "az": "Single-AZ",
      "commitment": 1,
      "monthCommitment": 1,
      "monthOnDemandCost": 1,
      "monthSaveCost": 1,
      "residualOnDemandCost": 1,
      "onDemandCost": 1,
      "onDemandCostOnlyEC2": 1,
      "reservedInstanceOnDemandCost": 1,
      "savingsPlansOnDemandCost": 1,
      "savingsPlansOnDemandCostOnlyEC2": 1,
      "coverageRate": 1,
      "expectancyCoverageRate": 1
    }
  ]
}

Get purchase option information of AWS commitment recommendation

get

Retrieve the cost information based on AWS commitment purchase options and their corresponding purchase outcomes.

Authorizations

Path parameters

companyIdstringRequired

Company ID

servicestringRequired

Query parameters

productstringRequired

Recommendation target product

purchasestringRequired

Service

termstringRequired

Analysis terms

Example: 14

linkedAccountsstringOptional

Linked accounts

purchaseOptionstringOptional

Purchase option

leasContractLengthstringOptional

Commitment terms

offerClassstringOptional

Offer Class

analyzeTypeCodestringOptional

Savings Plan analysis type code

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": [
    {
      "paymentOptions": "All Upfront",
      "termLength": "1yr",
      "offerClass": "standard",
      "analyzeTypeCode": "text",
      "analyzeTypeName": "text",
      "residualOnDemandCost": 1,
      "onDemandCostBeforePurchase": 1,
      "monthCommitment": 1,
      "monthSaveCost": 1,
      "onDemandCost": 1,
      "onDemandCostOnlyEC2": 1,
      "reservedInstanceOnDemandCost": 1,
      "savingsPlansOnDemandCost": 1,
      "savingsPlansOnDemandCostOnlyEC2": 1,
      "coverageRate": 1,
      "expectancyCoverageRate": 1,
      "linkedAccountId": "text",
      "accounts": [
        {
          "paymentOptions": "All Upfront",
          "termLength": "1yr",
          "offerClass": "standard",
          "analyzeTypeCode": "text",
          "analyzeTypeName": "text",
          "residualOnDemandCost": 1,
          "onDemandCostBeforePurchase": 1,
          "monthCommitment": 1,
          "monthSaveCost": 1,
          "onDemandCost": 1,
          "onDemandCostOnlyEC2": 1,
          "reservedInstanceOnDemandCost": 1,
          "savingsPlansOnDemandCost": 1,
          "savingsPlansOnDemandCostOnlyEC2": 1,
          "coverageRate": 1,
          "expectancyCoverageRate": 1,
          "linkedAccountId": "text",
          "accounts": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Get list of user's AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased by user).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

Get list of AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased list).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

Get category list of AWS Reserved Instance inventory

get

Retrieve the categories of AWS Reserved Instance inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get list of AutoSavings AWS Reserved Instance inventory

get

Retrieve Reserved Instance inventory(purchased by AutoSavings).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "reservedInstanceId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "AmazonEC2",
      "productName": "EC2",
      "instanceType": "c4.xlarge",
      "instanceSize": "xlarge",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "platform": "Linux/UNIX",
      "useType": "APN2-HeavyUsage:t3.micro",
      "operationName": "RunInstances",
      "tenancy": "Shared",
      "riCount": 5,
      "status": "active",
      "offerClass": "standard",
      "arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
      "upfrontFee": 777,
      "recurringFee": 777,
      "az": "777",
      "multiAz": "777"
    }
  ]
}

Get utilization data of AWS Reserved Instance

get

Retrieve utilization data of each AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "reservedInstanceId": "ri-2020-03-27-04-12-02-595",
      "reservedInstanceArn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5
    }
  ]
}

Get utilization summary trends of AWS Reserved Instance

get

Retrieve time-series utilization summary for AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of AWS Reserved Instance utilization

get

Retrieve the categories of AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get utilization summary of AWS Reserved Instance

get

Retrieve aggregated utilization summary for AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 1,
    "usedCommitmentCostOnDemandEquivalent": 1,
    "usageDate": "2020-07-01"
  }
}

Get utilization data of user's AWS Reserved Instance

get

Retrieve utilization data of user's each AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "reservedInstanceId": "ri-2020-03-27-04-12-02-595",
      "reservedInstanceArn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5
    }
  ]
}

Get utilization summary trends of user's AWS Reserved Instance

get

Retrieve time-series utilization summary for user's AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of user's AWS Reserved Instance utilization

get

Retrieve the categories of user's AWS Reserved Instance utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get utilization summary of user's AWS Reserved Instance

get

Retrieve aggregated utilization summary for user's AWS Reserved Instance.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']

productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

searchTypestringOptional

Commitment search type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 1,
    "usedCommitmentCostOnDemandEquivalent": 1,
    "usageDate": "2020-07-01"
  }
}

Get list of user's AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased by user).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

Get list of AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased list).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

Get category list of AWS Savings Plans inventory

get

Retrieve the categories of AWS Savings Plans inventory. The items within these categories can be used when categorizing the Savings Plans commitments.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get list of AutoSavings AWS Savings Plans inventory

get

Retrieve Savings Plans inventory(purchased by AutoSavings).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "123456789012",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "duration": 31536000,
      "useType": "text",
      "operationName": "text",
      "status": "active",
      "arn": "arn:aws:savingsplans::123456789012:savingsplan/3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "hourlyCommitmentCost": 100,
      "upfrontFee": 100,
      "recurringFee": 100
    }
  ]
}

Get utilization data of AWS Savings Plans

get

Retrieve utilization data of each AWS Savings Plans.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "savingsPlansId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespin",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceFamily": "c4",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)"
    }
  ]
}

Get utilization summary trends of AWS Savings Plans

get

Retrieve time-series utilization summary for AWS Savings Plans.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of AWS Savings Plans utilization

get

Retrieve the categories of AWS Savings Plans utilization. The items within these categories can be used when categorizing the values of Savings Plans related to utilization.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get utilization summary of AWS Savings Plans

get

Retrieve aggregated utilization summary for AWS Savings Plans.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 1,
    "usedCommitmentCostOnDemandEquivalent": 1,
    "usageDate": "2020-07-01"
  }
}

Get utilization data of AWS commitment

get

Retrieve utilization data of each AWS commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "commitmentId": "ri-2020-03-27-04-12-02-595",
      "arn": "arn:aws:rds:ap-northeast-2:216093335544:ri:ri-2020-03-27-04-12-02-595",
      "linkedAccountId": "123456789012",
      "linkedAccountAlias": "Bespinglobal Platform",
      "productCode": "EC2InstanceSavingsPlans",
      "productName": "EC2 Instance",
      "instanceType": "c5.2xlarge",
      "instanceSize": "c4.xlarge",
      "tenancy": "Shared",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "purchaseOption": "All Upfront",
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "platform": "Linux/UNIX",
      "operationName": "RunInstances",
      "riCount": 5,
      "commitmentType": "text"
    }
  ]
}

Get utilization summary trends of AWS commitment

get

Retrieve time-series utilization summary for AWS commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 78.15,
      "commitmentCost": 3690.19,
      "usedCommitmentCost": 2880,
      "netSavingsCost": 810.19,
      "netSavingsRate": 1,
      "usedCommitmentCostOnDemandEquivalent": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of AWS commitment utilization

get

Retrieve the categories of AWS commitment utilization. The items within these categories can be used when categorizing the values of commitment related to utilization.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "accounts": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)",
        "parentCode": "RGNCONVERT",
        "codes": "['t3s','m5','c5']",
        "sort": 1
      }
    ]
  }
}

Get utilization summary of AWS commitment

get

Retrieve aggregated utilization summary for AWS commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Start Date

Example: 2020-10-01

endDatestringRequired

End Date

Example: 2020-10-31

accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']

productsstringOptional

Service type

Example: ['EC2InstanceReserved', 'ComputeReserved']

isExpiredstringOptional

Whether the commitment is expired

Example: false

searchTypestringOptional

Commitment search Type

Example: All, My, AutoSavings

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "utilization": 78.15,
    "commitmentCost": 3690.19,
    "usedCommitmentCost": 2880,
    "netSavingsCost": 810.19,
    "netSavingsRate": 1,
    "usedCommitmentCostOnDemandEquivalent": 1,
    "usageDate": "2020-07-01"
  }
}

Get result list of Azure Reservations recommendation

get

Retrieve results of Azure Reservations recommendations

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

servicestringRequired

Query parameters

toKRWbooleanOptional

To convert amount data to Korean Won(₩)

Default: false

lookbackPeriodstringRequired

Azure Lookback Period

Example: 30

termstringOptional

Commitment term

Example: P1Y

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": [
    {
      "accountId": "123456789012",
      "accountAlias": "Bespinglobal Platform",
      "product": "c4.xlarge",
      "startDate": "2022-01-31",
      "endDate": "2022-03-01",
      "subscriptionId": "daf98eb5-6b7b-432d-a263-8d54aed4679d",
      "subscriptionAlias": "BespinGlobal - FinOps",
      "sku": "Standard_DS2_v2",
      "resourceType": "Microsoft.Consumption/reservationRecommendations",
      "location": "koreasouth",
      "instanceFlexibilityGroup": "DSv2 Series",
      "instanceFlexibilityRate": "2",
      "lookbackPeriod": "Last30Days",
      "termLength": "P3Y",
      "commitmentCount": "3",
      "monthSaveCost": 3.8589864578035966,
      "monthOnDemandCost": 8.759077781999997,
      "reservationCost": 4.9000913241964,
      "originCurrency": "$"
    }
  ]
}

Get list of GCP CUD(Committed Use Discount) inventory

get

Retrieve Reserved Instance inventory(purchased list).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "projectId": "sample-project",
      "projectName": "OpsNow Sample",
      "commitmentTypeName": "Compute Engine",
      "machineType": "GENERAL_PURPOSE_E2",
      "machineTypeName": "General-purpose E2",
      "regionCode": "ap-northeast-2",
      "regionName": "Asia Pacific (Seoul)",
      "remainingDays": 365,
      "startDate": "2019-01-01 23:59:59",
      "endDate": "2011-01-01 23:59:58",
      "plan": "text",
      "status": "active",
      "cpuAmount": 1,
      "memoryAmount": 1,
      "storageAmount": 1,
      "gpuAmount": 1
    }
  ]
}

Get category list of GCP CUD(Committed Use Discount) inventory

get

Retrieve the categories of GCP CUD(Committed Use Discount) inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

Get utilization data of GCP CUD(Committed Use Discount)

get

Retrieve utilization data of each GCP CUD(Committed Use Discount).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "totalCount": 123,
  "list": [
    {
      "utilization": 1,
      "commitmentCapacity": 1,
      "usedCapacity": 1,
      "commitmentCost": 1,
      "usedCommitmentCost": 1,
      "committedUseDiscountOnDemandCostEquivalent": 1,
      "netSavingsCost": 1,
      "netSavingsRate": 1,
      "projectId": "text",
      "projectName": "text",
      "regionCode": "us-central1",
      "regionName": "us-central1",
      "productCode": "text",
      "productName": "Compute Engine",
      "machineType": "E2",
      "commitmentTypeName": "Compute Engine",
      "resourceType": "vCPU",
      "unit": "vCPU"
    }
  ]
}

Get utilization summary trends of GCP CUD(Committed Use Discount)

get

Retrieve time-series utilization summary for GCP CUD(Committed Use Discount).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "utilization": 1,
      "commitmentCapacity": 1,
      "usedCapacity": 1,
      "commitmentCost": 1,
      "usedCommitmentCost": 1,
      "committedUseDiscountOnDemandCostEquivalent": 1,
      "netSavingsCost": 1,
      "netSavingsRate": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of GCP CUD(Committed Use Discount) utilization

get

Retrieve the categories of GCP CUD(Committed Use Discount) utilization. The items within these categories can be used when categorizing the values of Reserved Instance related to utilization.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

Get utilization summary of GCP CUD(Committed Use Discount)

get

Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "utilization": 1,
    "commitmentCapacity": 1,
    "usedCapacity": 1,
    "commitmentCost": 1,
    "usedCommitmentCost": 1,
    "committedUseDiscountOnDemandCostEquivalent": 1,
    "netSavingsCost": 1,
    "netSavingsRate": 1,
    "usageDate": "2020-07-01"
  }
}

Get coverage data of GCP commitment

get

Retrieve coverage data of each GCP commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "committedUseDiscountCoverageRate": 1,
      "totalCost": 1,
      "totalOnDemandCostEquivalent": 1,
      "totalCreditCost": 1,
      "totalCommitmentCreditCost": 1,
      "committedUseDiscountOnDemandCostEquivalent": 1,
      "sustainedUseDiscountOnDemandCostEquivalent": 1,
      "etcCreditOnDemandCostEquivalent": 1,
      "onDemandCost": 1,
      "projectId": "text",
      "projectName": "text",
      "regionCode": "us-central1",
      "regionName": "us-central1",
      "productCode": "text",
      "productName": "Compute Engine",
      "machineType": "E2",
      "commitmentTypeName": "text",
      "resourceType": "vCPU"
    }
  ]
}

Get coverage summary trends of GCP commitment

get

Retrieve time-series coverage summary for GCP commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

dateTypestringRequired

Date query type

Example: DAILY

Query parameters

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "list": [
    {
      "committedUseDiscountCoverageRate": 1,
      "totalCost": 1,
      "totalOnDemandCostEquivalent": 1,
      "totalCreditCost": 1,
      "totalCommitmentCreditCost": 1,
      "committedUseDiscountOnDemandCostEquivalent": 1,
      "sustainedUseDiscountOnDemandCostEquivalent": 1,
      "etcCreditOnDemandCostEquivalent": 1,
      "onDemandCost": 1,
      "usageDate": "2020-07-01"
    }
  ]
}

Get category list of GCP commitment coverage

get

Retrieve the categories of GCP commitment coverage. The items within these categories can be used when categorizing the values of commitment related to coverage.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "projects": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "commitmentTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "regions": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "machineTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "resourceTypes": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ],
    "products": [
      {
        "code": "ap-northeast-2",
        "name": "Asia Pacific (Seoul)"
      }
    ]
  }
}

Get coverage summary of GCP commitment

get

Retrieve aggregated coverage summary for GCP commitment.

Authorizations

Path parameters

companyIdstringRequired

Company ID

Example: 1

Query parameters

dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:

startDatestringRequired

Search start Date

Example: 2020-10-01

endDatestringRequired

Search end Date

Example: 2020-10-31

projectsstringOptional

Project IDs

Example: ['pjt-sample-1', 'pjt-sample-2']

committedTypesstringOptional

CUD types

Example: ['compute#commitment', 'cloudSql#commitment']

regionsstringOptional

Regions

Example: ['1', '2']

machineTypesstringOptional

Machine types

Example: ['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']

productsstringOptional

Products

resourceTypesstringOptional

Resource types

Responses

200

*/*

get

GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "status": "text",
  "error": {
    "Code": 1,
    "Message": "text"
  },
  "data": {
    "committedUseDiscountCoverageRate": 1,
    "totalCost": 1,
    "totalOnDemandCostEquivalent": 1,
    "totalCreditCost": 1,
    "totalCommitmentCreditCost": 1,
    "committedUseDiscountOnDemandCostEquivalent": 1,
    "sustainedUseDiscountOnDemandCostEquivalent": 1,
    "etcCreditOnDemandCostEquivalent": 1,
    "onDemandCost": 1
  }
}