Edit

AutoSavings

AutoSavings Account APIs

Get AutoSavings account List

get

Retrieve information about the AWS account registered with the company.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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

Get AutoSavings Account Subscription Histories

get

Retrieve AWS AutoSavings subscription histories

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
latestbooleanOptional

View the latest subscription information by account

Default: true
Responses
200

OK

*/*
get
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: */*
200

OK

{
  "list": [
    {
      "vendor": "text",
      "linkedAccountId": "text",
      "payerAccountId": "text",
      "autoSavingsService": "text",
      "accountType": "text",
      "subscriptionStatus": "text",
      "startDateTime": "text",
      "cancelDateTime": "text",
      "endDateTime": "text"
    }
  ]
}

Get AutoSavings Account State

get

Retrieve registered AWS AutoSavings accounts state

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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

Get AutoSavings account AWS role ARN Info

get

Retrieve the necessary information for AWS cross-account registration.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
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: */*
200

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

Get AutoSavings Site Region

get

Retrieve Information about customer sites utilizing AWS AutoSavings.

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
GET /cost/v3/autosave/companies/{companyId}/vendors/aws/services/accounts/region HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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

AutoSavings Account - All Vendor APIs

Get AutoSavings Account Subscription Histories

get

Retrieve Azure AutoSavings subscription histories

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
latestbooleanOptional

View the latest subscription information by account

Default: true
Responses
200

OK

*/*
get
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: */*
200

OK

{
  "list": [
    {
      "vendor": "text",
      "linkedAccountId": "text",
      "payerAccountId": "text",
      "autoSavingsService": "text",
      "accountType": "text",
      "subscriptionStatus": "text",
      "startDateTime": "text",
      "cancelDateTime": "text",
      "endDateTime": "text"
    }
  ]
}

Get Azure AutoSavings Account State

get

Retrieve registered Azure AutoSavings accounts state for specified period

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
GET /cost/v3/autosave/companies/{companyId}/vendors/all/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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

AutoSavings Azure Account APIs

Get AutoSavings Account Subscription Histories

get

Retrieve Azure AutoSavings subscription histories

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
latestbooleanOptional

View the latest subscription information by account

Default: true
Responses
200

OK

*/*
get
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: */*
200

OK

{
  "list": [
    {
      "vendor": "text",
      "linkedAccountId": "text",
      "payerAccountId": "text",
      "autoSavingsService": "text",
      "accountType": "text",
      "subscriptionStatus": "text",
      "startDateTime": "text",
      "cancelDateTime": "text",
      "endDateTime": "text"
    }
  ]
}

Get Azure AutoSavings Account State

get

Retrieve registered Azure AutoSavings accounts state for specified period

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
browserTimeZonestringOptional

Browser Timezone

Example: +09:00
linkedAccountIdstringOptional

Linked Account ID

Example: '123456789011'
linkedAccountAliasstringOptional

Linked Account Name

Example: 'Alias equals name'
accessTypestringOptional

AutoSavings AWS account access type

Example: 'role-arn / access-key '
roleArnstringOptional

roleArn

Example: 'roleArn'
accessKeystringOptional
secretKeystringOptional
tokenstringOptional
startDatestringOptional
endDatestringOptional
siteRegionstringOptional

siteRegion

Example: 'GLOBAL / CHINA'
servicesstringOptional

AutoSavings services subscribed to by the account

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

Current AutoSavings subscription status of the account

Example: 'SUBSCRIBED'
Responses
200

OK

*/*
get
GET /cost/v3/autosave/companies/{companyId}/vendors/azure/services/accounts/state HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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

Integrated(User & AutoSavings) Coverage APIs

Get Savings Plans List

get

Get Coverage List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings
commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance
Responses
200

OK

*/*
get
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: */*
200

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 Savings Plans Total Transition

get

Get Coverage Total Transition

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
dateTypestringRequired

Date query type

Example: DAILY
Query parameters
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings
commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance
Responses
200

OK

*/*
get
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: */*
200

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 Savings Plans Filter

get

Get Coverage Filter

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings
commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance
Responses
200

OK

*/*
get
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: */*
200

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 Savings Plans total summary

get

Get Coverage Total summary

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2020-10-01
endDatestringRequired

End Date

Example: 2020-10-31
accountsstringOptional

Linked Account IDs

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
autoRiYnstringOptional

If retrieve only AutoRI or not

searchTypestringOptional

Search type

Example: All, My, AutoSavings
commitmentServicestringOptional

AWS commitment service type

Example: all, savings-plans, reserved-instance
Responses
200

OK

*/*
get
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: */*
200

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

Integrated(User & AutoSavings) Inventory APIs

Get My Inventory List

get

Get My Inventory List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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

get

Get Savings Plans Inventory List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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

get

Get AutoSavings Inventory List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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

Integrated(User & AutoSavings) Inventory - Azure APIs

Get My Azure Inventory List

get

Get My Azure Inventory List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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 list of Azure Reservations inventory

get

Retrieve Azure Reservations inventory (same as commitment API)

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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 category list of Azure Reservations inventory

get

Retrieve the categories of Azure Reservations inventory (same as commitment API)

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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

get

Get AutoSavings Azure Inventory List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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

Integrated(User & AutoSavings) Utilization APIs

Get Agreement Utilization List

get

Get Agreement Utilization List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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-10-13T08:20:32.735Z",
      "endDate": "2025-10-13T08:20:32.735Z"
    }
  ]
}

Get Total Transition

get

Get Utilization Total Transition

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
dateTypestringRequired

Date query type

Example: DAILY
Query parameters
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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

get

Overview Monthly Overview Savings

Authorizations
Path parameters
companyIdstringRequired

Company ID

Query parameters
startDatestringOptional

Search start date

endDatestringOptional

Search end date

Responses
200

OK

*/*
get
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: */*
200

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 Filter

get

Get Utilization Filter

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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 total summary

get

Get Utilization Total summary

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
accountsstringOptional

Linked Account ID

Example: ['123456789011', '123456789012']
productsstringOptional

Products

Example: ['EC2InstanceReserved', 'ComputeReserved']
regionsstringOptional

Regions

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

Instance types

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

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
Responses
200

OK

*/*
get
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: */*
200

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

Integrated(User & AutoSavings) Utilization - Azure APIs

Get Agreement Utilization List

get

Get Azure Agreement Utilization List

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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-10-13T08:20:32.735Z",
      "endDate": "2025-10-13T08:20:32.735Z"
    }
  ]
}

Get Total Transition

get

Get Azure Utilization Total Transition (Monthly Aggregation)

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
dateTypestringRequired

Date query type

Example: DAILY
Query parameters
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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 Overview Savings

get

Overview Monthly Azure Overview Savings

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
minusMonthstringOptional

Months to look back

Example: 12
Responses
200

OK

*/*
get
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: */*
200

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 Filter

get

Get Azure Utilization Filter

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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 total summary

get

Get Azure Utilization Total summary

Authorizations
Path parameters
companyIdstringRequired

Company ID

Example: 1
Query parameters
dateTypestring · enumOptional

Date query type

Example: DAILYPossible values:
startDatestringRequired

Start Date

Example: 2023-10-01
endDatestringRequired

End Date

Example: 2023-10-31
subscriptionIdsstringOptional

Subscription ID

Example: ['123456789011', '123456789012']
displayNamesstringOptional

Display Name

Example: ['123456789011', '123456789012']
productNamesstringOptional

Product Names

Example: ['Virtual Machines', 'SQL Database']
accountsstringOptional

Linked Account ID

Example: ['subscription-1', 'subscription-2']
productsstringOptional

Products

Example: ['VirtualMachines', 'SQLDatabase']
regionsstringOptional

Regions

Example: ['eastus', 'westus']
instanceTypesstringOptional

Instance types

Example: ['Standard_D2s_v3', 'Standard_B1s']
opsnowProductCodesstringOptional

OpsNow RI Purchase types

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

Search type

Example: All, My, AutoSavings
isExpiredstringOptional

Include expired reservations

Example: false
Responses
200

OK

*/*
get
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: */*
200

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
  }
}
PreviousResourcesNextCommitment

Last updated

Was this helpful?