Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This document introduces the official API of opsnow.io
At opsnow.io, 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.
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.
/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.
Endpoints Overview
api.opsnow.ioEach service URL is composed with the hostname to form the endpoint of each API.
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_HEREFor 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.
Access the opsnow.io service and request the issuance of an API Key.
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.
curl -X POST "https://api.opsnow.io/platform/v2/identity/api-keys/token" \
-H "Content-Type: application/json" \
-d '{"apiKey":"YOUR_API_KEY"}'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.
/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..
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.
Indicates that there is an error on the opsnow.io server.
opsnow.io also outputs error messages and error codes in JSON format.
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.
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.
{
"status": "fail",
"error": {
"code": 401,
"message": "Unauthorized"
}
}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.
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 [email protected] to upgrade your limits.
Retrieve 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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"companyId": "1",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"accessType": "role-arn",
"roleArn": "aws:arn:123456:api",
"siteRegion": "GLOBAL",
"deleteYn": "0:false / 1:true",
"createDate": "'%Y-%m-%d %H:%i:%s'",
"createUser": "user",
"updateDate": "'%Y-%m-%d %H:%i:%s'",
"updateUser": "user"
}
],
"roleArnInfo": {
"cloudFormationTemplateUrl": "text",
"externalId": "text"
},
"data": {
"siteRegion": "text"
}
}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
trueOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/subscription/histories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"list": [
{
"vendor": "text",
"linkedAccountId": "text",
"payerAccountId": "text",
"autoSavingsService": "text",
"accountType": "text",
"subscriptionStatus": "text",
"startDateTime": "text",
"cancelDateTime": "text",
"endDateTime": "text"
}
]
}Retrieve 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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"linkedAccountId": "text",
"linkedAccountName": "text",
"autoRiSubscribed": true,
"autoSpSubscribed": true,
"subscribed": true,
"purchase": true,
"estimatedCost": 1,
"accountStatus": "text"
}
]
}
}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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/role-arn HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"companyId": "1",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"accessType": "role-arn",
"roleArn": "aws:arn:123456:api",
"siteRegion": "GLOBAL",
"deleteYn": "0:false / 1:true",
"createDate": "'%Y-%m-%d %H:%i:%s'",
"createUser": "user",
"updateDate": "'%Y-%m-%d %H:%i:%s'",
"updateUser": "user"
}
],
"roleArnInfo": {
"cloudFormationTemplateUrl": "text",
"externalId": "text"
},
"data": {
"siteRegion": "text"
}
}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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"companyId": "1",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"accessType": "role-arn",
"roleArn": "aws:arn:123456:api",
"siteRegion": "GLOBAL",
"deleteYn": "0:false / 1:true",
"createDate": "'%Y-%m-%d %H:%i:%s'",
"createUser": "user",
"updateDate": "'%Y-%m-%d %H:%i:%s'",
"updateUser": "user"
}
],
"roleArnInfo": {
"cloudFormationTemplateUrl": "text",
"externalId": "text"
},
"data": {
"siteRegion": "text"
}
}Retrieve Azure 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
trueOK
GET /cost/v3/autosave/companies/{companyId}/vendors/all/services/accounts/subscription/histories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"list": [
{
"vendor": "text",
"linkedAccountId": "text",
"payerAccountId": "text",
"autoSavingsService": "text",
"accountType": "text",
"subscriptionStatus": "text",
"startDateTime": "text",
"cancelDateTime": "text",
"endDateTime": "text"
}
]
}Retrieve registered Azure AutoSavings accounts state for specified period
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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/all/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"aws": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"linkedAccountId": "text",
"linkedAccountName": "text",
"autoRiSubscribed": true,
"autoSpSubscribed": true,
"subscribed": true,
"purchase": true,
"estimatedCost": 1,
"accountStatus": "text"
}
]
},
"azure": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"subscriptionId": "text",
"subscriptionName": "text",
"subscribed": true,
"estimatedCost": 1
}
]
}
}
}Retrieve Azure 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
trueOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/accounts/subscription/histories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"list": [
{
"vendor": "text",
"linkedAccountId": "text",
"payerAccountId": "text",
"autoSavingsService": "text",
"accountType": "text",
"subscriptionStatus": "text",
"startDateTime": "text",
"cancelDateTime": "text",
"endDateTime": "text"
}
]
}Retrieve registered Azure AutoSavings accounts state for specified period
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'OK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"subscriptionId": "text",
"subscriptionName": "text",
"subscribed": true,
"estimatedCost": 1
}
]
}
}Get Coverage List
Company ID
1Date query type
DAILYPossible values: 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-instanceOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"reservedInstanceCoverageRate": 1,
"savingsPlansCoverageRate": 1,
"autoRiCoverageRate": 1,
"autoSpCoverageRate": 1,
"onDemandCoverageRate": 1,
"reservedInstanceOnDemandCostEquivalent": 1,
"savingsPlansOnDemandCostEquivalent": 1,
"autoRiOnDemandCostEquivalent": 1,
"autoSpOnDemandCostEquivalent": 1,
"onDemandCost": 1,
"totalOnDemandCostEquivalent": 1,
"reservedInstanceNormalizeFactorAmount": 1,
"savingsPlansNormalizeFactorAmount": 1,
"autoRiNormalizeFactorAmount": 1,
"autoSpNormalizeFactorAmount": 1,
"onDemandNormalizeFactorAmount": 1,
"totalNormalizeFactorAmount": 1,
"reservedInstanceAmount": 1,
"savingsPlansAmount": 1,
"autoRiAmount": 1,
"autoSpAmount": 1,
"onDemandAmount": 1,
"totalAmount": 1,
"linkedAccountId": "123456789011",
"linkedAccountAlias": "Service Platform",
"productCode": "AmazonEC2",
"productName": "EC2",
"platform": "Linux",
"instanceType": "c4.xlarge",
"instanceSize": "c4.xlarge",
"tenancy": "Shared",
"regionCode": "ap-northeast-2",
"regionName": "Asia Pacific (Seoul)"
}
]
}Get 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-instanceOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"reservedInstanceCoverageRate": 1,
"savingsPlansCoverageRate": 1,
"autoRiCoverageRate": 1,
"autoSpCoverageRate": 1,
"onDemandCoverageRate": 1,
"reservedInstanceOnDemandCostEquivalent": 1,
"savingsPlansOnDemandCostEquivalent": 1,
"autoRiOnDemandCostEquivalent": 1,
"autoSpOnDemandCostEquivalent": 1,
"onDemandCost": 1,
"totalOnDemandCostEquivalent": 1,
"reservedInstanceNormalizeFactorAmount": 1,
"savingsPlansNormalizeFactorAmount": 1,
"autoRiNormalizeFactorAmount": 1,
"autoSpNormalizeFactorAmount": 1,
"onDemandNormalizeFactorAmount": 1,
"totalNormalizeFactorAmount": 1,
"reservedInstanceAmount": 1,
"savingsPlansAmount": 1,
"autoRiAmount": 1,
"autoSpAmount": 1,
"onDemandAmount": 1,
"totalAmount": 1,
"usageDate": "2020-07-01"
}
]
}Get Coverage Filter
Company ID
1Date query type
DAILYPossible values: 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-instanceOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"accounts": "['123456789011', '123456789012']",
"products": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
"regions": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
"instanceTypes": "[ 't2.micro', 'm4.xlarge' ]",
"opsNowProducts": "[ 'SELF', 'AUTO-RI']"
}
}Get Coverage Total summary
Company ID
1Date query type
DAILYPossible values: 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-instanceOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/coverages/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"reservedInstanceCoverageRate": 1,
"savingsPlansCoverageRate": 1,
"autoRiCoverageRate": 1,
"autoSpCoverageRate": 1,
"onDemandCoverageRate": 1,
"reservedInstanceOnDemandCostEquivalent": 1,
"savingsPlansOnDemandCostEquivalent": 1,
"autoRiOnDemandCostEquivalent": 1,
"autoSpOnDemandCostEquivalent": 1,
"onDemandCost": 1,
"totalOnDemandCostEquivalent": 1,
"reservedInstanceNormalizeFactorAmount": 1,
"savingsPlansNormalizeFactorAmount": 1,
"autoRiNormalizeFactorAmount": 1,
"autoSpNormalizeFactorAmount": 1,
"onDemandNormalizeFactorAmount": 1,
"totalNormalizeFactorAmount": 1,
"reservedInstanceAmount": 1,
"savingsPlansAmount": 1,
"autoRiAmount": 1,
"autoSpAmount": 1,
"onDemandAmount": 1,
"totalAmount": 1
}
}Get My Inventory List
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/my-list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "AmazonEC2",
"productName": "EC2",
"instanceType": "c4.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",
"operationName": "RunInstances",
"status": "active",
"arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
"hourlyCommitmentCost": 100,
"upfrontFee": 777,
"recurringFee": 777
}
]
}Get Savings Plans Inventory List
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "AmazonEC2",
"productName": "EC2",
"instanceType": "c4.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",
"operationName": "RunInstances",
"status": "active",
"arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
"hourlyCommitmentCost": 100,
"upfrontFee": 777,
"recurringFee": 777
}
]
}Get AutoSavings Inventory List
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/inventory/auto-list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "3118c6a8-7fc3-4b5d-8b53-a82fbe6f3169",
"linkedAccountId": "123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "AmazonEC2",
"productName": "EC2",
"instanceType": "c4.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",
"operationName": "RunInstances",
"status": "active",
"arn": "arn:aws:rds:ap-northeast-2:249145062117:ri:ri-2020-05-15-05-12-58-377",
"hourlyCommitmentCost": 100,
"upfrontFee": 777,
"recurringFee": 777
}
]
}Get My Azure Inventory List
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/inventory/my-list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "ff190dc7-3f20-4b92-825d-896084a00f4b",
"linkedAccountId": "12345678-1234-1234-1234-123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "VirtualMachines",
"productName": "Virtual Machines",
"instanceType": "Standard_D2s_v3",
"regionCode": "eastus",
"regionName": "East US",
"purchaseOption": "Monthly",
"remainingDays": 365,
"startDate": "2020-10-12 05:28:52",
"endDate": "2023-10-12 00:00:00",
"duration": 94608000,
"platform": "text",
"operationName": "text",
"status": "Active",
"arn": "text",
"hourlyCommitmentCost": 3.5,
"upfrontFee": 0,
"recurringFee": 3.5
}
]
}Retrieve Azure Reservations inventory (same as commitment API)
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/inventory/list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "ff190dc7-3f20-4b92-825d-896084a00f4b",
"linkedAccountId": "12345678-1234-1234-1234-123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "VirtualMachines",
"productName": "Virtual Machines",
"instanceType": "Standard_D2s_v3",
"regionCode": "eastus",
"regionName": "East US",
"purchaseOption": "Monthly",
"remainingDays": 365,
"startDate": "2020-10-12 05:28:52",
"endDate": "2023-10-12 00:00:00",
"duration": 94608000,
"platform": "text",
"operationName": "text",
"status": "Active",
"arn": "text",
"hourlyCommitmentCost": 3.5,
"upfrontFee": 0,
"recurringFee": 3.5
}
]
}Retrieve the categories of Azure Reservations inventory (same as commitment API)
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/inventory/categories?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"subscriptions": [
{
"code": "ap-northeast-2",
"name": "Asia Pacific (Seoul)"
}
],
"products": [
{
"code": "ap-northeast-2",
"name": "Asia Pacific (Seoul)"
}
]
}
}Get AutoSavings Azure Inventory List
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/inventory/auto-list?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"inventoryId": "ff190dc7-3f20-4b92-825d-896084a00f4b",
"linkedAccountId": "12345678-1234-1234-1234-123456789012",
"linkedAccountAlias": "Bespinglobal Platform",
"productCode": "VirtualMachines",
"productName": "Virtual Machines",
"instanceType": "Standard_D2s_v3",
"regionCode": "eastus",
"regionName": "East US",
"purchaseOption": "Monthly",
"remainingDays": 365,
"startDate": "2020-10-12 05:28:52",
"endDate": "2023-10-12 00:00:00",
"duration": 94608000,
"platform": "text",
"operationName": "text",
"status": "Active",
"arn": "text",
"hourlyCommitmentCost": 3.5,
"upfrontFee": 0,
"recurringFee": 3.5
}
]
}Get Agreement Utilization List
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"utilization": 78.15,
"commitmentCost": 2880,
"usedCommitmentCost": 3690.19,
"netSavingsCost": 810.19,
"usedCommitmentCostOnDemandEquivalent": 1,
"netSavingsRate": 28.13,
"opsNowProduct": "AUTO-RI",
"inventoryId": "ri-2020-03-27-04-12-02-595",
"inventoryArn": "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",
"regionCode": "ap-northeast-2",
"regionName": "Asia Pacific (Seoul)",
"purchaseOption": "All Upfront",
"startDate": "2025-12-07T08:53:14.123Z",
"endDate": "2025-12-07T08:53:14.123Z"
}
]
}Get 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/time-series/{dateType}?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"utilization": 78.15,
"commitmentCost": 2880,
"usedCommitmentCost": 3690.19,
"netSavingsCost": 810.19,
"netSavingsRate": 28.13,
"usedCommitmentCostOnDemandEquivalent": 1,
"usageDate": "2020-07-01",
"opsNowProduct": "AUTO-RI"
}
]
}Overview Monthly Overview Savings
Company ID
Search start date
Search end date
OK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/overview-savings HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"state": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"linkedAccountId": "text",
"linkedAccountName": "text",
"autoRiSubscribed": true,
"autoSpSubscribed": true,
"subscribed": true,
"purchase": true,
"estimatedCost": 1,
"accountStatus": "text"
}
]
},
"list": [
{
"yearMonth": "text",
"lastDay": "Service Platform",
"totalSavingCost": 1,
"autoSavingCost": 1,
"mySavingCost": 1,
"estimatedCost": 1,
"estimatedAutoSavingCost": 1,
"estimatedMySavingCost": 1,
"savingsCostComparedPreviousMonth": 1,
"savingsRateComparedPreviousMonth": 1
}
],
"lastMonthNetSavings": {
"yearMonth": "text",
"lastDay": "Service Platform",
"totalSavingCost": 1,
"autoSavingCost": 1,
"mySavingCost": 1,
"estimatedCost": 1,
"estimatedAutoSavingCost": 1,
"estimatedMySavingCost": 1,
"savingsCostComparedPreviousMonth": 1,
"savingsRateComparedPreviousMonth": 1
}
}Get Utilization Filter
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/categories?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"accounts": "['123456789011', '123456789012']",
"products": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
"regions": "[ {'code':'EC2InstanceReserved', 'value':'EC2 Instance'} ]",
"instanceTypes": "[ 't2.micro', 'm4.xlarge' ]",
"opsNowProducts": "[ 'SELF', 'AUTO-RI']"
}
}Get Utilization Total summary
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/integration/utilizations/aggregated?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"utilization": 78.15,
"commitmentCost": 2880,
"usedCommitmentCost": 3690.19,
"netSavingsCost": 810.19,
"netSavingsRate": 28.13,
"usedCommitmentCostOnDemandEquivalent": 1,
"usageDate": "2020-07-01",
"opsNowProduct": "AUTO-RI"
}
}Get Azure Agreement Utilization List
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/utilizations?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"commitmentCost": 1234.56,
"usedCommitmentCost": 1234.56,
"netSavingsCost": 1234.56,
"usedCommitmentCostOnDemandEquivalent": 1234.56,
"utilization": 85.5,
"netSavingsRate": 25.3,
"inventoryId": "ri-2020-03-27-04-12-02-595",
"inventoryArn": "/subscriptions/12345678-1234-1234-1234-123456789abc/providers/Microsoft.Capacity/reservationOrders/...",
"linkedAccountId": "12345678-1234-1234-1234-123456789abc",
"linkedAccountAlias": "Production Subscription",
"productCode": "VirtualMachines",
"productName": "Virtual Machines",
"instanceType": "Standard_D2s_v3",
"instanceSize": "Standard_D2s_v3",
"regionCode": "eastus",
"regionName": "East US",
"purchaseOption": "Upfront",
"startDate": "2025-12-07T08:53:14.123Z",
"endDate": "2025-12-07T08:53:14.123Z"
}
]
}Get Azure Utilization Total Transition (Monthly Aggregation)
Company ID
1Date query type
DAILYStart Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/utilizations/time-series/{dateType}?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"list": [
{
"commitmentCost": 1234.56,
"usedCommitmentCost": 1234.56,
"netSavingsCost": 1234.56,
"usedCommitmentCostOnDemandEquivalent": 1234.56,
"utilization": 85.5,
"netSavingsRate": 25.3,
"usageDate": "2020-07-01"
}
]
}Overview Monthly Azure Overview Savings
Company ID
1Months to look back
12OK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/utilizations/overview-savings HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"state": {
"totalCount": 1,
"subscriptionCount": 1,
"state": "NONE",
"savingsCost": 1,
"monthlyEstimateCost": 1,
"accounts": [
{
"subscriptionId": "text",
"subscriptionName": "text",
"subscribed": true,
"estimatedCost": 1
}
]
},
"list": [
{
"yearMonth": "text",
"lastDay": "Production Subscription",
"totalSavingCost": 1,
"autoSavingCost": 1,
"mySavingCost": 1,
"estimatedCost": 1,
"estimatedAutoSavingCost": 1,
"estimatedMySavingCost": 1,
"savingsCostComparedPreviousMonth": 1,
"savingsRateComparedPreviousMonth": 1
}
],
"lastMonthNetSavings": {
"yearMonth": "text",
"lastDay": "Production Subscription",
"totalSavingCost": 1,
"autoSavingCost": 1,
"mySavingCost": 1,
"estimatedCost": 1,
"estimatedAutoSavingCost": 1,
"estimatedMySavingCost": 1,
"savingsCostComparedPreviousMonth": 1,
"savingsRateComparedPreviousMonth": 1
}
}Get Azure Utilization Filter
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/utilizations/categories?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"accounts": "['sub-123456789011', 'sub-123456789012']",
"products": "[ {'code':'VirtualMachines', 'value':'Virtual Machines'} ]",
"regions": "[ {'code':'eastus', 'value':'East US'} ]",
"instanceTypes": "[ 'Standard_D2s_v3', 'Standard_B1s' ]",
"opsNowProducts": "[ 'SELF', 'AUTO-RI']"
}
}Get Azure Utilization Total summary
Company ID
1Date query type
DAILYPossible values: Start Date
2023-10-01End Date
2023-10-31Subscription ID
['123456789011', '123456789012']Display Name
['123456789011', '123456789012']Product Names
['Virtual Machines', 'SQL Database']Linked Account ID
['subscription-1', 'subscription-2']Products
['VirtualMachines', 'SQLDatabase']Regions
['eastus', 'westus']Instance types
['Standard_D2s_v3', 'Standard_B1s']OpsNow RI Purchase types
['AUTO-RI', 'AUTO-SP', 'CLIENT-RI']Search type
All, My, AutoSavingsInclude expired reservations
falseOK
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/integration/utilizations/aggregated?startDate=2023-10-01&endDate=2023-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": {
"commitmentCost": 1234.56,
"usedCommitmentCost": 1234.56,
"netSavingsCost": 1234.56,
"usedCommitmentCostOnDemandEquivalent": 1234.56,
"utilization": 85.5,
"netSavingsRate": 25.3
}
}View abnormal cost detection history list
company id
companyIduser id
userIdAbnormal Cost Analysis Type
accountAbnormal Cost AI/Manual Type
manualOK
OK
View ai/manual abnormal cost detection daily grid data
Analyze Type
aicompany id
companyIduser id
userIdHistory Seq
0Anomaly Rule Seq
0OK
OK
View abnormal cost detection notification sent history
company id
companyIduser id
userIdHistory Seq
0Anomaly Rule Seq
0OK
OK
View abnormal cost detection history details and pie chart data
company id
companyIduser id
userIdHistory Seq
0Anomaly Rule Seq
0OK
OK
View manual abnormal cost detection history details and pie chart data inquiry
company id
companyIduser id
userIdHistory Seq
0Anomaly Rule Seq
0OK
OK
View the trend of cost anomalies detected by AI.
Vendor
AWScompany id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSSensitivity
MForecast Date
2024-06-02OK
OK
View the cost trend of cloud usage.
Vendor
AWScompany id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
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_costSelected 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-02OK
OK
View the usage data that may lead to ai-predicted anomalous costs
Vendor
AWScompany id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSSelected Vendors by Widget
["AWS","GCP"]Sensitivity
MForecast Date
2024-09-23OK
OK
View the number of triggered alerts and abnormal cost information by cloud vendor and type.
company id
companyIduser id
userIdList of vendors
["AWS"]OK
OK
View the number of triggered alerts and abnormal cost information by cloud vendor and type.
Vendor
AWScompany id
companyIduser id
userIdList of vendors
["AWS"]OK
OK
Create or update the setting of anomaly detection rule.
company id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
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
accountOK
OK
View the rules for detecting anomalies and sending alerts.
company id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSList of vendors
["AWS"]OK
OK
View the specific rule for detecting anomalies and sending alerts.
Rule Seq
0company id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSAnomaly Rule Seq
0OK
OK
Retrieve monthly billing summary including invoices and services. Required parameters: companyId, searchYear, searchMnth, vndr
company id
companyIduser id
userIdSearch Year
2025Search Month (01-12)
05Vendor (AWS)
AWSLinked Account ID (optional)
linkedAccountIdsuccess
Internal Server Error
View detailed portion chart data of cost analytics
company id
companyIduser id
userIdAWS2019-08-122023-02-012024-02-12account216093335544216093335544VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]falseOK
OK
View detailed grid of cost analytics
company id
companyIduser id
userIdAWS2019-08-122023-02-012024-02-12account216093335544216093335544VisibleFields of detail grid
["vendor","linkedAccountId","productName","region","usage","cost","usageType"]falseOK
OK
View summary of cost analytics
company id
companyIduser id
userIdstart date
2023-02-01end date
2024-02-12items per page
30page number
1user name
abcdview by
accountselected vendors
["AWS"]monthly
falseOK
OK
View Cost Analytics filter
company id
companyIduser id
userIdCost 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"]OK
OK
View Cost Analytics filter
company id
companyIduser id
userIdCost 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"]OK
OK
View Category of cost analytics
company id
companyIduser id
userIdCost 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"]OK
OK
Retrieve exchange rate information for a specific company and vendor
company id
companyIdTarget cloud vendor
Target currency for exchange rate
Target year month
user id
userIdOK
OK
View cloud costs from the previous period and the estimated costs for the current month.
company id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSselected Vendor
AWSThe last date to include in the data range (inclusive). If not provided, defaults to the UTC current date.
OK
OK
View the latest cloud costs collection date of each vendor.
company id
123e4567-e89b-12d3-a456-426614174000company name
ex-company-rnamedefault vendor
AWSuser id
390df5f7-8852-40af-bc12-57a318cb9dc3user name
ex-user-namevendor
AWSOK
OK
View cloud accounts and status from specific vendor
company id
companyIduser id
userIdvendor
AWSOK
OK
menu
usagevendor
awsview type
historyCompany id
1Resource Type
ec2Vendor
awsView Type(current, history)
historymenu
usageOK
OK
View Filter Data Quick Search For Usage
Menu Id
usageCompany id
1Action Type(current, history)
currentOK
OK
Grid detail data inquiry according to optimization category and resource type
Company id
1000000000000ap-northeast-2vol-00000ebsawsPossible values: idleOK
OK
Grid 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
OK
OK
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
OK
OK
Reset the optimization setting conditions for each resource by optimization category.
Company id
1Vendor
Resource Type
ec2Optimization category
right-sizingPossible values: OK
OK
View list of support resources by optimization type
Optimization category
OK
OK
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
ec2OK
OK
View the list of tags excluded from resource optimization.
Company unique ID
Rule id
DefaultOK
OK
Search for optimization rule set ID using site and company information.
Company Id
1OK
OK
Search the top filter area data for each vendor.
Company id
1Action Type(current, history)
currentOK
OK
Company id
1OK
No content
OK
No content
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
OK
OK
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
OK
OK
Search the optimization summary information for each vendor.
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
OK
OK
View History Usage Grid Data
Vendor
awsPossible values: 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
OK
OK
View Current Usage Grid Data
Vendor
awsPossible values: 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
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
YOK
OK
View Current Usage Chart Data
Vendor
awsPossible values: Company id
1Resource Type
ec2Vendor
awsResource Name
testRegions
Service Groups
Accounts
Whether to exclude deleted resources
YOK
OK
View History Usage Chart Data
Vendor
awsPossible values: Company id
1From Date
2024-09-11To Date
2024-09-25Resource Type
ec2Vendor
awsRegions
Service Groups
Accounts
View Type(hour, day, week, month)
dayOK
OK
Get tag keys for specified AWS account IDs
OK
OK
OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Get tagging status and billing tag compliant
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Company id
1OK
OK
Get tag compliance and status statistics
OK
OK
Get tag compliance and status statistics
OK
OK
OK
OK
Get required tags information for AWS
OK
OK
awsOK
OK
Company id
1OK
OK
POST /cost/v3/billing/anomaly/history/list HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"companyId": "companyId",
"userId": "userId",
"analyzeBy": "account",
"analyzeType": "manual"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 67
{
"companyId": "companyId",
"userId": "userId",
"histSeq": 0,
"ruleSeq": 0
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/anomaly/history/detail/sent HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"companyId": "companyId",
"userId": "userId",
"histSeq": 0,
"ruleSeq": 0
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/anomaly/history/detail/result HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"companyId": "companyId",
"userId": "userId",
"histSeq": 0,
"ruleSeq": 0
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/anomaly/history/detail/manual/period-chart HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"companyId": "companyId",
"userId": "userId",
"histSeq": 0,
"ruleSeq": 0
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 276
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"sensitivity": "M",
"forecastDt": "2024-06-02"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 765
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"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"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 318
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"selectedVendorsByWidget": [
"AWS",
"GCP"
],
"sensitivity": "M",
"forecastDate": "2024-09-23"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/anomaly/vendors/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"companyId": "companyId",
"userId": "userId",
"vendors": [
"AWS"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/anomaly/vendors/{vendor}/aggregate HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"companyId": "companyId",
"userId": "userId",
"vendors": [
"AWS"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 513
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"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"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 253
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"vendorList": [
"AWS"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 240
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"seq": 0
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/summary HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"companyId": "companyId",
"searchYear": "2025",
"searchMnth": "05",
"vndr": "AWS",
"lnkdAccId": "linkedAccountId"
}{
"data": {
"summary": {
"invoices": [
{
"cmpnId": "companyId",
"billYear": "2025",
"billMnth": "05",
"vndr": "AWS",
"payrAccId": "382377105752",
"lnkdAccId": "216093335544",
"invcId": "2175433553",
"excgRate": 1381.4,
"useCost": 34103.7224496458,
"discCost": 0,
"suppCost": 0,
"crdtCost": 0,
"totCost": 34103.7224496458,
"excgCost": 47110882
}
],
"services": [
{
"cmpnId": "companyId",
"billYear": "2025",
"billMnth": "05",
"vndr": "AWS",
"payrAccId": "382377105752",
"lnkdAccId": "216093335544",
"invcId": "2175433553",
"addType": "SUPPORT",
"addDesc": "AWS Premium Support",
"excgCost": "1500000"
}
]
}
},
"status": "success"
}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: 2189
{
"companyId": "companyId",
"userId": "userId",
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 2189
{
"companyId": "companyId",
"userId": "userId",
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 1892
{
"companyId": "companyId",
"userId": "userId",
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"serviceGroup": [
{
"serviceGroupKey": "text",
"serviceGroupValue": "text",
"serviceGroupSetNm": "text",
"serviceGroupSetId": "text",
"serviceGroupNm": "text",
"serviceGroupId": "text",
"dfltYn": "text"
}
]
}
},
"isMonthly": false
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 1892
{
"companyId": "companyId",
"userId": "userId",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 1892
{
"companyId": "companyId",
"userId": "userId",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 1892
{
"companyId": "companyId",
"userId": "userId",
"conditions": {
"aws": {
"linkedAccountId": [
"text"
],
"productCode": [
"text"
],
"region": [
"text"
],
"productFamily": [
"text"
],
"tags": [
{
"tagKey": "text",
"tagValue": "text"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
}
],
"billingTags": [
{
"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"
]
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}GET /cost/v3/billing/currency/company/{companyId}/vendor/{vendor}/exchange HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 272
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS",
"selectedVendor": "AWS",
"endDate": "text"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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: 232
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "ex-company-rname",
"defaultVendor": "AWS",
"userEmail": "[email protected]",
"userId": "390df5f7-8852-40af-bc12-57a318cb9dc3 ",
"userName": "ex-user-name",
"vendor": "AWS"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}POST /cost/v3/billing/overview/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"companyId": "companyId",
"userId": "userId",
"vendor": "AWS"
}{
"status": "success",
"error": {
"code": "OK",
"message": "Error Message"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
}
]
}{
"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"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
]
}
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
]
}
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/optimization/setting/optimize-category/{optimizeCategory} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"result": [
{
"vendor": "text",
"resourceType": "text",
"resourceName": "text"
}
],
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/optimization/setting/companies/{cmpnId}/rule-sets/{ruleSetId}/deny HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"ruleSetId": "text"
},
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}PUT /asset/us-v1/optimization/summary/filter 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"
}
]
}{
"data": {
"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"
}
}POST /asset/us-v1/optimization/summary/report-download HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 835
{
"cmpnId": "1",
"vndrList": [
"text"
],
"analyYn": "text",
"idleSetId": "text",
"idleSetNm": "text",
"pageNum": 1,
"limitCnt": 1,
"offset": 1,
"searchText": "text",
"type": "text",
"sortId": "text",
"sortOrder": "text",
"currentRuleSet": "text",
"gridType": "text",
"listType": "text",
"rsrcType": "text",
"excelYn": "text",
"today": "text",
"bzList": [
"text"
],
"awsAccList": [
"text"
],
"awsRgnList": [
"text"
],
"azuAccList": [
"text"
],
"azuRgnList": [
"text"
],
"aliAccList": [
"text"
],
"aliRgnList": [
"text"
],
"gcpAccList": [
"text"
],
"gcpRgnList": [
"text"
],
"ncpAccList": [
"text"
],
"ncpRgnList": [
"text"
],
"chartType": "text",
"rcmd": "text",
"currentCost": 1,
"addRcmdGrp": "text",
"tz": "text",
"rcmdList": [
"text"
],
"cmpnNm": "text",
"rprtType": "text",
"rprtTitleName": "text",
"rprtFlag": "text",
"rprtSbscId": "text",
"rsrcList": [
{
"cnt": 1,
"rsrcType": "text",
"vndr": "text"
}
],
"bzGrpSetId": "text",
"svcGrpList": [
"text"
]
}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"
]
}
]
}{
"data": {
"lastExecuteDate": "2025-12-07T08:53:14.123Z"
},
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
]
}
]
}{
"data": [
{
"resourceType": "text",
"expectedSavingCost": 1,
"expectedSavingCount": 1
}
],
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/optimization/summary 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"
]
}
]
}{
"data": {
"totalCost": 1,
"totalCnt": 1,
"rightsizing": [
{
"resourceType": "text",
"expectedSavingCost": 1,
"expectedSavingCount": 1
}
],
"unused": [
{
"resourceType": "text",
"expectedSavingCost": 1,
"expectedSavingCount": 1
}
]
},
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/optimization/general/analysis HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"cmpnId": "1"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
]
}
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/vendors/{vendor}/tag-keys HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"vendor": "aws",
"page": 1,
"size": 1,
"offset": 1,
"accIds": [
"text"
],
"sort": "text",
"sortColId": "text",
"sortDirection": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/vendors/{vendor}/tag-keys/{tagKey}/tag-vals HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"vendor": "aws",
"page": 1,
"size": 1,
"offset": 1,
"accIds": [
"text"
],
"sort": "text",
"sortColId": "text",
"sortDirection": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/undo-tagging HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 397
{
"cmpnId": "1",
"vendor": "aws",
"taggingId": "text",
"undoId": "text",
"taggingResourceList": [
{
"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",
"reviewTagList": [
{
"tagKey": "text",
"oldValue": "text",
"newValue": "text"
}
]
}
],
"userEmail": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/tag-processing-status HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"cmpnId": "1",
"vendor": "aws",
"taggingId": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/retry-tagging HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"cmpnId": "1",
"vendor": "aws",
"taggingId": "text",
"retryId": "text",
"taggingResourceList": [
{
"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",
"reviewTagList": [
{
"tagKey": "text",
"oldValue": "text",
"newValue": "text"
}
]
}
],
"userEmail": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/resources/tags HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"cmpnId": "1",
"vendor": "aws",
"data": [
{
"accId": "text",
"rsrcType": "text",
"rgnId": "text",
"instId": "text",
"tagKey": "text"
}
]
}{
"result": [
{
"tagKey": "text",
"tagValue": [
"text"
],
"isCommon": true
}
],
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources/email-export HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: 724
{
"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"
],
"resourceGroups": [
"text"
],
"tagKeys": [
"text"
],
"antiTagKeys": [
"text"
],
"tagType": "text",
"tagTypes": [
"text"
],
"tagTypeCondition": "text",
"tags": [
{
"tagKey": "text",
"tagVal": "text",
"creaDt": "2025-12-07T08:53:14.123Z",
"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",
"taggingStatus": "text",
"taggingStatuses": [
"text"
]
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/tag-manager/add-tag HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"cmpnId": "1",
"vendor": "aws",
"taggingId": "text",
"taggingResourceList": [
{
"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",
"reviewTagList": [
{
"tagKey": "text",
"oldValue": "text",
"newValue": "text"
}
]
}
],
"userEmail": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}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: 381
{
"cmpnId": "1",
"vendor": "aws",
"taggingId": "text",
"taggingResourceList": [
{
"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",
"reviewTagList": [
{
"tagKey": "text",
"oldValue": "text",
"newValue": "text"
}
]
}
],
"userEmail": "text"
}{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys/{tagKey}/tag-vals HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/tag HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/resource HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups/{groupId}/resources HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/billing-tags HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/histories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}GET /asset/us-v1/tag-manager/companies/{cmpnId}/histories/{historyId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}POST /asset/us-v1/rsrcopti/summary HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 697
{
"cmpnId": "1",
"vndr": "text",
"analyYn": "text",
"idleSetId": "text",
"idleSetNm": "text",
"pageNum": 1,
"limitCnt": 1,
"offset": 1,
"searchText": "text",
"type": "text",
"sortId": "text",
"sortOrder": "text",
"currentRuleSet": "text",
"gridType": "text",
"listType": "text",
"rsrcType": "text",
"excelYn": "text",
"today": "text",
"accList": [
"text"
],
"bzList": [
"text"
],
"rgnList": [
"text"
],
"chartType": "text",
"rcmd": "text",
"currentCost": 1,
"addRcmdGrp": "text",
"tz": "text",
"rcmdList": [
"text"
],
"vndrList": [
"text"
],
"rprtFlag": "text",
"accOrigine": "text",
"bzGrpSetId": "text",
"batchYn": "text",
"rprtSbscCcl": "text",
"rprtSbscCclRng": "text",
"utcTimeStamp": "text",
"rprtSbscCclTime": "text",
"unusedRsrcTypes": "text",
"rightSizingRsrcTypes": "text"
}{
"result": {
"summaryTotalCost": {
"currentCost": 1,
"totalCost": 1,
"unusedCost": 1,
"rightSizingCost": 1,
"totalCnt": 1,
"unusedCnt": 1,
"rightSizingCnt": 1
},
"gridSummary": {
"unusedResource": {
"totalCnt": 1,
"cnt": 1,
"cost": 1,
"resource": {
"ANY_ADDITIONAL_PROPERTY": {
"rsrcType": "text",
"totalCnt": 1,
"cnt": 1,
"cost": 1,
"type": "text",
"prodNm": "text",
"apiNm": "text"
}
}
},
"rightSizing": {
"totalCnt": 1,
"cnt": 1,
"cost": 1,
"resource": {
"ANY_ADDITIONAL_PROPERTY": {
"rsrcType": "text",
"totalCnt": 1,
"cnt": 1,
"cost": 1,
"type": "text",
"prodNm": "text",
"apiNm": "text"
}
}
}
},
"currency": "text",
"cmpnId": "text"
},
"status": "text",
"error": {
"code": "text",
"message": "text"
}
}Retrieve 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations?product=text&purchase=text&term=14 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/purchase-options?product=text&purchase=text&term=14 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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]"
]
}
]
}
]
}Retrieve product types targeted by AWS commitment recommendation
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": [
{
"code": "ap-northeast-2",
"name": "Asia Pacific (Seoul)",
"parentCode": "RGNCONVERT",
"codes": "['t3s','m5','c5']",
"sort": 1
}
]
}Retrieve Reserved Instance inventory(purchased by user).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}Retrieve Reserved Instance inventory(purchased list).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}Retrieve 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
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/inventory/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve Reserved Instance inventory(purchased by AutoSavings).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/auto-savings-inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}Retrieve utilization data of each AWS Reserved Instance.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}Retrieve 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve aggregated utilization summary for AWS Reserved Instance.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
}Retrieve utilization data of user's each AWS Reserved Instance.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}Retrieve 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve aggregated utilization summary for user's AWS Reserved Instance.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/reserved-instance/my-utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
}Retrieve Savings Plans inventory(purchased by user).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/my-inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}Retrieve Savings Plans inventory(purchased list).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}Retrieve 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
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/inventory/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve Savings Plans inventory(purchased by AutoSavings).
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/auto-savings-inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}Retrieve utilization data of each AWS Savings Plans.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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)"
}
]
}Retrieve 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve aggregated utilization summary for AWS Savings Plans.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/savings-plans/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
}Retrieve utilization data of each AWS commitment.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}Retrieve 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}Retrieve 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
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}
}Retrieve aggregated utilization summary for AWS commitment.
Company ID
1Date query type
DAILYPossible values: 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, AutoSavingsOK
GET /cost/v3/commitment/companies/{companyId}/vendors/aws/services/all/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
}Retrieve results of Azure Reservations recommendations
Company ID
1To convert amount data to Korean Won(₩)
falseAzure Lookback Period
30Commitment term
P1YOK
GET /cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations?lookbackPeriod=30 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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": "$"
}
]
}Retrieve product types targeted by Azure Reservations recommendation
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/azure/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": [
{
"code": "ap-northeast-2",
"name": "Asia Pacific (Seoul)",
"parentCode": "RGNCONVERT",
"codes": "['t3s','m5','c5']",
"sort": 1
}
]
}Retrieve Reserved Instance inventory(purchased list).
Company ID
1Date query type
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
]
}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
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/inventory/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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)"
}
]
}
}Retrieve utilization data of each GCP CUD(Committed Use Discount).
Company ID
1Date query type
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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)"
}
]
}
}Retrieve aggregated utilization summary for GCP CUD(Committed Use Discount).
Company ID
1Date query type
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/utilizations/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
}Retrieve coverage data of each GCP commitment.
Company ID
1Date query type
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/time-series/{dateType}?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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"
}
]
}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
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/categories?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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)"
}
]
}
}Retrieve aggregated coverage summary for GCP commitment.
Company ID
1Date query type
DAILYPossible values: 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
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/cud/coverages/aggregated?startDate=2020-10-01&endDate=2020-10-31 HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"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
}
}Retrieve results of GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendations
Company ID
1OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": [
{
"accountId": "123456789012",
"accountAlias": "Bespinglobal Platform",
"product": "c4.xlarge",
"projectId": "opsnow-global-prd",
"recommendationId": "0a2e6861-fd68-4e2e-8232-1e14e816deec",
"recommendType": "GENERAL_PURPOSE",
"recommendAmount": 1024,
"recommendAction": "1024",
"recommendStatus": "ACTIVE",
"recommendDescription": "Purchase a 1 year RAM commitment for region us-central1",
"resourceType": "MEMORY",
"expectedCost": -0.800516,
"plan": "TWELVE_MONTH",
"termLength": "1yr",
"goal": "LOW_WATERMARK",
"regionId": "us-central1",
"regionName": "Council Bluffs, Iowa",
"regionCategory": "North America",
"insightId": "1377dfe4-f62d-4074-b52a-93a64a5a1b9d",
"monthCommitment": 1,
"monthSaveCost": 1,
"onDemandCost": 1
}
]
}Retrieve the cost information based on GCP(Google Cloud Platform) CUD(Committed Use Discounts) purchase options and their corresponding purchase outcomes.
Company ID
1OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/purchase-options HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": [
{
"goal": "LOW_WATERMARK",
"plan": "TWELVE_MONTH",
"termLength": "1yr",
"currency": "USD",
"expectedCost": -0.800516,
"recommendAmount": 1024,
"monthCommitment": 1,
"monthSaveCost": 1,
"onDemandCost": 1
}
]
}Retrieve product types targeted by GCP(Google Cloud Platform) CUD(Committed Use Discounts) recommendation
OK
GET /cost/v3/commitment/companies/{companyId}/vendors/gcp/services/{service}/recommendations/products HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"status": "text",
"error": {
"Code": 1,
"Message": "text"
},
"data": [
{
"code": "ap-northeast-2",
"name": "Asia Pacific (Seoul)",
"parentCode": "RGNCONVERT",
"codes": "['t3s','m5','c5']",
"sort": 1
}
]
}Retrieves a list of all companies accessible to the logged-in user.
readPossible values: OK
Bad Request
Not Found
GET /platform/v2/companies HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"companyId": "123e4567-e89b-12d3-a456-426614174000",
"companyName": "company1",
"isMainCompany": "Y"
}
]
}
}Retrieves a list of all users associated with a company.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/users HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"userId": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"displayName": "John Doe",
"masterCompanyId": "65dd4cbf-b412-4f83-8476-97a3f1e161b2",
"userStatCd": "ACTIVATED",
"userRoleId": "ADMIN",
"userRoleName": "Admin",
"masterUserRole": "OWNER",
"enabled": true,
"createdDate": "2023-01-01T12:00:00.000Z"
}
]
}
}Retrieves 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.
masterOK
Bad Request
Not Found
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"
}
]
}
}Fetches 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.
123456789012OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"accountId": "123456789012",
"accountAlias": "AWS 1st DEV Infra Account",
"accountType": "master",
"managementAccountId": "987654321987",
"status": "healthy",
"roleArn": "arn:aws:iam::123456789012:role/role-name",
"stackName": "stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
"stackTemplateVersion": "1.0",
"curBucketName": "bucket-name",
"curBucketRegion": "us-east-1",
"curBucketPrefix": "cur",
"contractStatus": "us-east-1",
"createdDate": "2024-05-20T07:06:47.253Z",
"updatedDate": "2024-05-20T07:06:47.253Z"
}
}Updates 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.
trueOK
Bad Request
Not Found
PUT /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"accountAlias": "AWS 1st DEV Infra Account",
"isCancelDeleteAccount": true
}{
"status": "success",
"data": {
"accountId": "123456789012"
}
}Removes 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.
123456789012OK
Bad Request
Not Found
DELETE /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"accountId": "123456789012"
}
}Retrieves 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.
123456789012OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/aws/accounts/{accountId}/recommendation-savingsplan HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"netSavings": "10000.7",
"calculationStatus": "10000.7"
}
}Obtains 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.
123456789012, 234567890123OK
Bad Request
Not Found
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¶m_CostUsageReportBucketName=cur-d442326f-878e-4500-8f82-d7c868f275bb¶m_CrossAccountExternalID=ae06161e-8d5b-4c34-80c1-26f2cf00fff5¶m_CrossLinkedAccountID=370166107047¶m_Domain=opsnow360.io¶m_Profile=us2¶m_UserId=0f27a2-ae56-4a2f-8544-68ecb8674639¶m_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=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": "stack-7bfe7be4-b423-4e92-b6ad-b685ce2fb2e2",
"templateUrl": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
"crossAccountExternalId": "ae06161e-8d5b-4c34-80c1-26f2cf00fff5",
"crossLinkedAccountId": "123123123123",
"costUsageReportBucketName": "cur-d442326f-878e-4500-8f82-d7c868f275bb",
"domain": "sample.io",
"profile": "us2",
"userId": "a6e1e5f8-924d-4a8f-9f78-61c0879c9243",
"resourceId": "3f50b07a-df54-4a7e-8db7-75a5406e970d",
"organizationId": "f23a80d2-2077-4e0a-aa85-e7b08a379be7"
}
}Retrieves a list of AWS accounts associated with the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/aws/management-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"
}
]
}
}Retrieves a list of Azure tenants associated with the specified company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/azure/tenants HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
"applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
"tenantAlias": "First Tenant",
"tenantType": "PAY-AS-YOU-GO",
"status": "healthy",
"subscriptionCount": 5,
"createdDate": "2023-07-10T14:48:00.000Z",
"updatedDate": "2023-07-10T14:48:00.000Z"
}
]
}
}Creates 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-formatOK
Bad Request
Not Found
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"
}
}Obtains 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-087df0c16d6aOK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
"tenantAlias": "First Tenant",
"tenantType": "PAY-AS-YOU-GO",
"applicationId": "993a65dd-691f-44f7-ba1d-21e7b4c60d38",
"enrollmentNumber": "123456",
"status": "healthy",
"createdDate": "2023-07-10T14:48:00.000Z",
"updatedDate": "2023-07-10T14:48:00.000Z"
}
}Updates 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 TenantOK
Bad Request
Not Found
PUT /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"tenantAlias": "First Tenant"
}{
"status": "success",
"data": {
"tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a",
"subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95"
}
}Deletes 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-087df0c16d6aOK
Bad Request
Not Found
DELETE /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
}
}Retrieves 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-087df0c16d6aData source: 'console' for Azure Console, default is database
consoleOK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/azure/tenants/{tenantId}/subscriptions HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"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"
}
]
}
}Creates 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 SubscriptionOK
Bad Request
Not Found
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"
}
}Obtains 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-f7bd56fa8e95OK
Bad Request
Not Found
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"
}
}Updates 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 SubscriptionOK
Bad Request
Not Found
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"
}
}Deletes 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-f7bd56fa8e95OK
Bad Request
Not Found
DELETE /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": {
"subscriptionId": "c925a595-81d2-470c-a8cd-f7bd56fa8e95",
"tenantId": "6a05a771-d671-440a-9d64-087df0c16d6a"
}
}List 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|CSPOK
Bad Request
Not Found
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"
}
],
"tenantStatus": "text"
}
}Retrieves a list of GCP projects with the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/gcp/projects HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"projectId": "cloud-platform-1234",
"projectAlias": "My Cloud Project",
"projectType": "BILLING",
"companyName": "company1",
"serviceAccountId": "106821279384347983826",
"datasetId": "my_dataset",
"bigqueryTableName": "users_table",
"status": "active"
}
]
}
}Creates 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_datasetOK
Bad Request
Not Found
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"
}
}Retrieves 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-1234OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"projectId": "cloud-platform-1234",
"projectAlias": "My Cloud Project",
"companyName": "company1",
"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"
}
}Updates 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_datasetOK
Bad Request
Not Found
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"
}
}Deletes 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-1234OK
Bad Request
Not Found
DELETE /platform/v2/companies/{companyId}/vendors/gcp/projects/{projectId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"projectId": "cloud-platform-1234"
}
}Retrieves a list of GCP service accounts with the given company ID.
The ID of the organization, obtainable through 'listCompanies'.
f23a80d2-2077-4e0a-aa85-e7b08a379be7OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"serviceAccountId": "106821279384347983826",
"serviceAccountAlias": "my-service-account",
"serviceAccountEmail": "[email protected]",
"status": "healthy",
"createdDate": "2023-07-10T14:48:00.000Z",
"updatedDate": "2023-07-10T14:48:00.000Z"
}
]
}
}Creates 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>OK
Bad Request
Not Found
POST /platform/v2/companies/{companyId}/vendors/gcp/service-accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"serviceAccountAlias": "my-service-account",
"serviceAccountKey": "<Base64-encoded JSON key file string>"
}{
"status": "success",
"data": {
"serviceAccountId": "106821279384347983826"
}
}Retrieves 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.
106821279384347980000OK
Bad Request
Not Found
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": "[email protected]",
"createdDate": "2023-07-10T14:48:00.000Z",
"updatedDate": "2023-07-10T14:48:00.000Z",
"projects": [
{
"projectId": "cloud-platform-1234",
"projectAlias": "My Cloud Project",
"companyName": "company1",
"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"
}
]
}
}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-accountOK
Bad Request
Not Found
PUT /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"serviceAccountAlias": "my-service-account"
}{
"status": "success",
"data": {
"serviceAccountId": "106821279384347983826"
}
}Deletes 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.
106821279384347980000OK
Bad Request
Not Found
DELETE /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"
}
}Retrieves 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.
106821279384347980000OK
Bad Request
Not Found
GET /platform/v2/companies/{companyId}/vendors/gcp/service-accounts/{serviceAccountId}/projects HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"status": "success",
"data": {
"list": [
{
"projectId": "cloud-platform-1234",
"projectAlias": "My Cloud Project",
"projectType": "BILLING",
"companyName": "company1",
"serviceAccountId": "106821279384347983826",
"datasetId": "my_dataset",
"bigqueryTableName": "users_table",
"status": "active"
}
]
}
}