Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
/platform
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.
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.
/asset
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.
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..
This document introduces the official API of 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.
At , we're committed to simplifying the complexities of modern cloud infrastructure. Our CMP(Cloud Management Platform) stands at the forefront of this mission, providing unparalleled tools and insights for businesses.
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.
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.
opsnow.io uses standard HTTP response codes to indicate the success or failure of API requests. Typically, they are as follows:
Indicates inaccurate or incomplete parameters.
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.
Indicates that there is an error on the opsnow.io server.
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.
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:
For security reasons, keep the access token confidential.
Avoid hardcoding it directly into the application or exposing it in client-side scripts.
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.
The requested user information is verified, and an API Key will be issued.
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.
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.
Access the service and request the issuance of an API Key.
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.
Company Id
1Vendor
Optimization category
Rule id
Resource type
ec2Retrieve results of AWS commitment recommendation
Company ID
Recommendation target product
Service
Analysis terms
14Linked accounts
Purchase option
Commitment terms
Offer Class
Savings Plan analysis type code
Retrieve the cost information based on AWS commitment purchase options and their corresponding purchase outcomes.
Company ID
Recommendation target product
Service
Analysis terms
14Linked accounts
Purchase option
Commitment terms
Offer Class
Savings Plan analysis type code
Retrieve Reserved Instance inventory(purchased by user).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve Reserved Instance inventory(purchased list).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve the categories of AWS Reserved Instance inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve Reserved Instance inventory(purchased by AutoSavings).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve utilization data of each AWS Reserved Instance.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve time-series utilization summary for AWS Reserved Instance.
Company ID
1Date query type
DAILYStart Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve 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.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve aggregated utilization summary for AWS Reserved Instance.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve utilization data of user's each AWS Reserved Instance.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve time-series utilization summary for user's AWS Reserved Instance.
Company ID
1Date query type
DAILYStart Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve 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.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve aggregated utilization summary for user's AWS Reserved Instance.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
Commitment search type
All, My, AutoSavingsRetrieve Savings Plans inventory(purchased by user).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve Savings Plans inventory(purchased list).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve the categories of AWS Savings Plans inventory. The items within these categories can be used when categorizing the Savings Plans commitments.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve Savings Plans inventory(purchased by AutoSavings).
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve utilization data of each AWS Savings Plans.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve time-series utilization summary for AWS Savings Plans.
Company ID
1Date query type
DAILYStart Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve 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.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve aggregated utilization summary for AWS Savings Plans.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve utilization data of each AWS commitment.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve time-series utilization summary for AWS commitment.
Company ID
1Date query type
DAILYStart Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve the categories of AWS commitment utilization. The items within these categories can be used when categorizing the values of commitment related to utilization.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve aggregated utilization summary for AWS commitment.
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account ID
['123456789011', '123456789012']Service type
['EC2InstanceReserved', 'ComputeReserved']Whether the commitment is expired
falseCommitment search Type
All, My, AutoSavingsRetrieve results of Azure Reservations recommendations
Company ID
1To convert amount data to Korean Won(₩)
falseAzure Lookback Period
30Commitment term
P1YRetrieve Reserved Instance inventory(purchased list).
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve the categories of GCP CUD(Committed Use Discount) inventory. The items within these categories can be used when categorizing the Reserved Instance commitments.
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve utilization data of each GCP CUD(Committed Use Discount).
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve time-series utilization summary for GCP CUD(Committed Use Discount).
Company ID
1Date query type
DAILYSearch start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
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.
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve coverage data of each GCP commitment.
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve time-series coverage summary for GCP commitment.
Company ID
1Date query type
DAILYSearch start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve the categories of GCP commitment coverage. The items within these categories can be used when categorizing the values of commitment related to coverage.
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve aggregated coverage summary for GCP commitment.
Company ID
1Date query type
DAILYAvailable options: Search start Date
2020-10-01Search end Date
2020-10-31Project IDs
['pjt-sample-1', 'pjt-sample-2']CUD types
['compute#commitment', 'cloudSql#commitment']Regions
['1', '2']Machine types
['GENERAL_PURPOSE_E2','GENERAL_PURPOSE']Products
Resource types
Retrieve the cost information based on GCP(Google Cloud Platform) CUD(Committed Use Discounts) purchase options and their corresponding purchase outcomes.
Company ID
1menu
usagevendor
awsview type
historyCompany id
1Resource Type
ec2Vendor
awsView Type(current, history)
historymenu
usageView Filter Data Quick Search For Usage
Menu Id
usageCompany id
1Action Type(current, history)
currentES Search Key List
Grid detail data inquiry according to optimization category and resource type
Company id
1000000000000ap-northeast-2vol-00000ebsawsAvailable options: idleGrid data inquiry according to optimization category and resource type
Company id
1Optimization category
Resource type
ec2Cloud vendor
List of accounts to filter optimization results for
List of regions to filter optimization results for
List of serviceGroups to filter optimization results for
List of tags to filter optimization results for
View optimization charts by optimization category and resource type
Company id
1Optimization category
Resource type
ec2Cloud vendor
List of accounts to filter optimization results for
List of regions to filter optimization results for
List of serviceGroups to filter optimization results for
List of tags to filter optimization results for
Reset the optimization setting conditions for each resource by optimization category.
Company id
1Vendor
Resource Type
ec2Optimization category
right-sizingAvailable options: Queries the last time resource optimization was performed.
Company id
1Optimization category
Resource type
ec2Cloud vendor
List of accounts to filter optimization results for
List of regions to filter optimization results for
List of serviceGroups to filter optimization results for
List of tags to filter optimization results for
Search the top card area data for each optimization category.
Company id
1Optimization category
Resource type
ec2Cloud vendor
List of accounts to filter optimization results for
List of regions to filter optimization results for
List of serviceGroups to filter optimization results for
List of tags to filter optimization results for
View History Usage Grid Data
Vendor
awsAvailable options: Company id
1Page Limit Count
1Page Number Count
1Page Offset
1Page Total Count
1From Date
2024-09-11To Date
2024-09-25Sort Column ID
histDtSort Direction
descWhether to download Excel
NResource Type
ec2Vendor
awsHeader or not
YView Type(hour, day, week, month)
dayLanguage Code
enWhether to check history or not
trueSearch Text
testField List
Regions
Service Groups
Accounts
Tags
View Current Usage Grid Data
Vendor
awsAvailable options: Company id
1Region Id
ap-northeast-2Page Limit Count
1Page Number Count
1Page Offset
1Page Total Count
1Sort Column ID
seqSort Direction
descWhether to download Excel
NResource Type
ec2Vendor
awsView Type(hour, day, week, month)
dayFrom Date
2024-09-11To Date
2024-09-25Search Text
testHeader or not
YField List
Regions
Service Groups
Accounts
Tags
Service Group View Id
DefaultLanguage Code
enResource Seq
0Header Type
singleResource or Not
NResource Name
testWhether to check history or not
trueWhether to exclude deleted resources
YView Current Usage Chart Data
Vendor
awsAvailable options: Company id
1Resource Type
ec2Vendor
awsResource Name
testRegions
Service Groups
Accounts
Tags
Whether to exclude deleted resources
YView History Usage Chart Data
Vendor
awsAvailable options: Company id
1From Date
2024-09-11To Date
2024-09-25Resource Type
ec2Vendor
awsRegions
Service Groups
Accounts
Tags
View Type(hour, day, week, month)
dayGet tag keys for specified AWS account IDs
Company id
1Company id
1Company id
1Company id
1Company id
1Retrieve information about the AWS account registered with the company.
Company ID
1Browser Timezone
+09:00Linked Account ID
'123456789011'Linked Account Name
'Alias equals name'AutoSavings AWS account access type
'role-arn / access-key 'roleArn
'roleArn'siteRegion
'GLOBAL / CHINA'AutoSavings services subscribed to by the account
'AUTO-RI, AUTO-STORAGE, AUTO-DISKCurrent AutoSavings subscription status of the account
'SUBSCRIBED'Retrieve AWS AutoSavings subscription histories
Company ID
1Browser Timezone
+09:00Linked Account ID
'123456789011'Linked Account Name
'Alias equals name'AutoSavings AWS account access type
'role-arn / access-key 'roleArn
'roleArn'siteRegion
'GLOBAL / CHINA'AutoSavings services subscribed to by the account
'AUTO-RI, AUTO-STORAGE, AUTO-DISKCurrent AutoSavings subscription status of the account
'SUBSCRIBED'View the latest subscription information by account
trueRetrieve registered AWS AutoSavings accounts state
Company ID
1Browser Timezone
+09:00Linked Account ID
'123456789011'Linked Account Name
'Alias equals name'AutoSavings AWS account access type
'role-arn / access-key 'roleArn
'roleArn'siteRegion
'GLOBAL / CHINA'AutoSavings services subscribed to by the account
'AUTO-RI, AUTO-STORAGE, AUTO-DISKCurrent AutoSavings subscription status of the account
'SUBSCRIBED'Retrieve the necessary information for AWS cross-account registration.
Company ID
1Browser Timezone
+09:00Linked Account ID
'123456789011'Linked Account Name
'Alias equals name'AutoSavings AWS account access type
'role-arn / access-key 'roleArn
'roleArn'siteRegion
'GLOBAL / CHINA'AutoSavings services subscribed to by the account
'AUTO-RI, AUTO-STORAGE, AUTO-DISKCurrent AutoSavings subscription status of the account
'SUBSCRIBED'Retrieve Information about customer sites utilizing AWS AutoSavings.
Company ID
1Browser Timezone
+09:00Linked Account ID
'123456789011'Linked Account Name
'Alias equals name'AutoSavings AWS account access type
'role-arn / access-key 'roleArn
'roleArn'siteRegion
'GLOBAL / CHINA'AutoSavings services subscribed to by the account
'AUTO-RI, AUTO-STORAGE, AUTO-DISKCurrent AutoSavings subscription status of the account
'SUBSCRIBED'Get Coverage List
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']If retrieve only AutoRI or not
Search type
All, My, AutoSavingsAWS commitment service type
all, savings-plans, reserved-instanceGet Coverage Total Transition
Company ID
1Date query type
DAILYStart Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']If retrieve only AutoRI or not
Search type
All, My, AutoSavingsAWS commitment service type
all, savings-plans, reserved-instanceGet Coverage Filter
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']If retrieve only AutoRI or not
Search type
All, My, AutoSavingsAWS commitment service type
all, savings-plans, reserved-instanceGet Coverage Total summary
Company ID
1Date query type
DAILYAvailable options: Start Date
2020-10-01End Date
2020-10-31Linked Account IDs
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']If retrieve only AutoRI or not
Search type
All, My, AutoSavingsAWS commitment service type
all, savings-plans, reserved-instanceGet My Inventory List
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet Savings Plans Inventory List
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet AutoSavings Inventory List
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet Agreement Utilization List
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet Utilization Total Transition
Company ID
1Date query type
DAILYStart Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet Utilization Filter
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsGet Utilization Total summary
Company ID
1Date query type
DAILYAvailable options: Start Date
2023-10-01End Date
2023-10-31Linked Account ID
['123456789011', '123456789012']Products
['EC2InstanceReserved', 'ComputeReserved']Regions
[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]Instance types
[ 't2.micro', 'm4.xlarge' ]OpsNow RI Purchase types
[ 'AUTO-RI', 'AUTO-SP', 'CLIENT-RI' ]Search type
All, My, AutoSavingsView abnormal cost detection history list
site code
BESPINcompany id
1user id
abcdAbnormal Cost Analysis Type
accountAbnormal Cost AI/Manual Type
manualView ai/manual abnormal cost detection daily grid data
Analyze Type
aisite code
BESPINcompany id
1user id
abcdHistory Seq
0Anomaly Rule Seq
0View abnormal cost detection notification sent history
site code
BESPINcompany id
1user id
abcdHistory Seq
0Anomaly Rule Seq
0View abnormal cost detection history details and pie chart data
site code
BESPINcompany id
1user id
abcdHistory Seq
0Anomaly Rule Seq
0View manual abnormal cost detection history details and pie chart data inquiry
site code
BESPINcompany id
1user id
abcdHistory Seq
0Anomaly Rule Seq
0View the trend of cost anomalies detected by AI.
Vendor
AWSsite code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSSensitivity
MForecast Date
2024-06-02View the cost trend of cloud usage.
Vendor
AWSsite code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSList of vendors
Selected Vendors by Widget
["AWS"]View Type
accountComponent Type
dashboard_compare_cost_trend_widgetWidget Date Type
monthlyWidget Date Type (etc. monthly, weekly, daily)
monthly, weekly, dailyTime Frame
last_3_monthsView By(account,product,region)
accountFilter Type(top_10_by_cost / custom)
top_10_by_costCustom Filter
Selected Account Filter
000000000000Selected Accounts Filter
Selected Items Filter
Selected Tag Key Filter
NameSelected Service Group Set Filter
00000000-0000-0000-0000-000000000000Widget Selected Currency
Sensitivity value for a specific widget
MAnalysis date
2024-06-02View the usage data that may lead to ai-predicted anomalous costs
Vendor
AWSsite code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSSelected Vendors by Widget
["AWS","GCP"]Sensitivity
MForecast Date
2024-09-23View the number of triggered alerts and abnormal cost information by cloud vendor and type.
site code
BESPINcompany id
1user id
abcdList of vendors
["AWS"]View the number of triggered alerts and abnormal cost information by cloud vendor and type.
Vendor
AWSsite code
BESPINcompany id
1user id
abcdList of vendors
["AWS"]Create or update the setting of anomaly detection rule.
site code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSAnomaly Rule Seq
0Anomaly Rule Name
NameAbnormal Cost AI/Manual Type
manualAbnormal Cost Analysis Type
accountSensitivity
MThreshold value
1Threshold detection options(percentage/amount)
percentageAlarm Setting Status(active/inactive)
inactiveAlarm Frequency(daily, weekly)
dailyAlarm Option(only, all)
onlyAlarm recipients
Alarm Enabled
YForecast Date
2024-06-02Analysis date
2024-06-02View By
accountView the rules for detecting anomalies and sending alerts.
site code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSView the specific rule for detecting anomalies and sending alerts.
Rule Seq
0site code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSAnomaly Rule Seq
0View detailed portion chart data of cost analytics
site code
BESPINcompany id
1user id
abcdAWS2019-08-122023-02-012024-02-12account216093335544216093335544Cost Analytics Filters
Detail Filters
VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]Tags Filter
falseView detailed grid of cost analytics
site code
BESPINcompany id
1user id
abcdAWS2019-08-122023-02-012024-02-12account216093335544216093335544Cost Analytics Filters
Detail Filters
VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]Tags Filter
falseView summary of cost analytics
site code
BESPINcompany id
1user id
abcdstart date
2023-02-01end date
2024-02-12items per page
30page number
1user name
abcdview by
accountselected vendors
["AWS"]Cost Analytics Filters
monthly
falseView Cost Analytics filter
site code
BESPINcompany id
1user id
abcdCost Analytics Filters
Cost Analytics inquiry start date
2024-09-01Cost Analytics inquiry end date
2024-09-30View By
accountFilter query category
platformSelected Key
testSearch Text
testselected vendors
["AWS"]View Cost Analytics filter
site code
BESPINcompany id
1user id
abcdCost Analytics Filters
Cost Analytics inquiry start date
2024-09-01Cost Analytics inquiry end date
2024-09-30View By
accountFilter query category
platformSelected Key
testSearch Text
testselected vendors
["AWS"]View Category of cost analytics
site code
BESPINcompany id
1user id
abcdCost Analytics Filters
Cost Analytics inquiry start date
2024-09-01Cost Analytics inquiry end date
2024-09-30View By
accountFilter query category
platformSelected Key
testSearch Text
testselected vendors
["AWS"]View cloud costs from the previous period and the estimated costs for the current month.
site code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSselected Vendor
AWSThe last date to include in the data range (inclusive). If not provided, defaults to the UTC current date.
View the latest cloud costs collection date of each vendor.
site code
BESPINcompany id
1company name
1default vendor
AWSuser email
abcd@bespingloba.comuser id
abcduser name
abcdvendor
AWSRetrieves a list of AWS accounts associated with the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7Specifies whether additional Member Accounts can be registered when isAddReadyToStart is set to true.
trueThe 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.
masterFetches detailed information for a specific AWS account using the provided company and account IDs.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7The unique identifier of the AWS account.
123456789012Removes an AWS account from the system using the specified company and account IDs.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7The unique identifier of the AWS account.
123456789012Retrieves savings amount information for a specified AWS account, using the given company and account IDs.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7The unique identifier of the AWS account.
123456789012Obtains the setup information for an AWS account linked to the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7Used 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.
singleExample: singleWhen 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'.
123456789012, 234567890123Obtains the details of a specific Azure tenant linked to the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aDeletes a specific Azure tenant linked to the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aRetrieves a list of Azure subscriptions associated with the specified tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aObtains the details of a specific Azure subscription linked to the given tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aA unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.
c925a595-81d2-470c-a8cd-f7bd56fa8e95Deletes a specific Azure subscription linked to the specified tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aA unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.
c925a595-81d2-470c-a8cd-f7bd56fa8e95Retrieves detailed information about a specific GCP project linked to the given company ID and project ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.
cloud-platform-1234Deletes a specific Gcp Project linked to the specified project ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.
cloud-platform-1234Retrieves detailed information about a specific GCP service account and its associated project
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
106821279384347980000Deletes a specific Gcp Account linked to the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
106821279384347980000Retrieves a list of GCP projects with the given Service Account ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
106821279384347980000Updates the information of an existing AWS account identified by company and account IDs.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7The unique identifier of the AWS account.
123456789012The alias of the AWS account, used for easy identification.
AWS 1st DEV Infra AccountSpecifies whether to cancel the deletion of the AWS Account.
trueCreates a new Azure tenant for the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aThe alias name of the Azure tenant.
First TenantThe 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.
993a65dd-691f-44f7-ba1d-21e7b4c60d38The 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.
your-client-secretRepresents 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.
PAY-AS-YOU-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSPThe '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.
123456In 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.
jwt-token-formatUpdates the information of a specific Azure tenant associated with the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aThe alias name of the Azure tenant.
First TenantCreates a new Azure subscription for the specified tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aA unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.
c925a595-81d2-470c-a8cd-f7bd56fa8e95The alias name of the Azure subscription.
First SubscriptionUpdates the information of a specific Azure subscription associated with the given tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aA unique identifier for an Azure subscription, used to manage and bill for a set of Azure resources and services.
c925a595-81d2-470c-a8cd-f7bd56fa8e95The alias name of the Azure subscription.
First SubscriptionList registrable Azure subscriptions for the specified tenant ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
6a05a771-d671-440a-9d64-087df0c16d6aThe 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.
993a65dd-691f-44f7-ba1d-21e7b4c60d38The 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.
your-client-secretRepresents 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.
PAY-AS-YOU-GOPattern: PAY-AS-YOU-GO|EA|AZURE-PLAN|CSPCreates a new gcp project for the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
106821279384347983826A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.
cloud-platform-1234A user-friendly name or alias for a GCP project, used for easier identification and management.
My Cloud ProjectA unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.
my_datasetUpdates the information of a specific GCP project with the given project ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A unique identifier for a Google Cloud Platform project, used to organize and manage GCP resources, services, and billing.
cloud-platform-1234A user-friendly name or alias for a GCP project, used for easier identification and management.
My Cloud ProjectA unique identifier for a BigQuery dataset, which is a collection of tables and views in Google Cloud Platform.
my_datasetCreates a new gcp service account for the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7The alias name of the GCP service account.
my-service-accountA Base64-encoded string of the JSON key file containing the credentials for a GCP service account
<Base64-encoded JSON key file string>Updates the information of a specific GCP account associated with the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7A 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.
106821279384347980000The alias name of the GCP service account.
my-service-account