OpsNow Developer Guide
  • About
  • Endpoint
    • Platform
    • Resources
  • Authentication
  • Errors
  • Rate Limiting
  • API reference
    • Platform
    • Cost
    • Resources
    • AutoSavings
    • Commitment
Powered by GitBook

© 2023 OpsNow, Inc.

On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. API reference

Resources

PreviousCostNextAutoSavings

Last updated 15 hours ago

Was this helpful?

Common APIs

Elastic Search Filter APIs

Optimization Detail V3 APIs

Optimization Setting V3 APIs

Resource Optimization APIs

Resource Usage APIs

TagManager APIs

View list of support resources by optimization type

get

View list of support resources by optimization type

Authorizations
Path parameters
optimizeCategorystring · enumrequired

Optimization category

Available options:
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/setting/optimize-category/{optimizeCategory}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "result": [
    {
      "vendor": "text",
      "resourceType": "text",
      "resourceName": "text"
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

View list of resource optimization settings conditions

get

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

Authorizations
Path parameters
cmpnIdstringrequired

Company Id

Example: 1
vendorstring · enumrequired

Vendor

Available options:
optimizeCategorystring · enumrequired

Optimization category

Available options:
ruleSetIdstringrequired

Rule id

Query parameters
resourceTypestringoptional

Resource type

Example: ec2
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/vendors/{vendor}/optimize-category/{optimizeCategory}/rule-sets/{ruleSetId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

View list of resource optimization excluded tags

get

View the list of tags excluded from resource optimization.

Authorizations
Path parameters
cmpnIdstringrequired

Company unique ID

ruleSetIdstringrequired

Rule id

Example: Default
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-sets/{ruleSetId}/deny' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Search for optimization rule set ID of the site and company

get

Search for optimization rule set ID using site and company information.

Authorizations
Path parameters
cmpnIdstringrequired

Company Id

Example: 1
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "data": {
    "ruleSetId": "text"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tagKeys

get
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tagKeyVals

get
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
tagKeystringrequired
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys/{tagKey}/tag-vals' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tag statistics

get

Get tag compliance and status statistics

Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/tag' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tag statistics

get

Get tag compliance and status statistics

Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/resource' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get AWS resource required tags

get

Get required tags information for AWS

Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/required-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get resources for a specific tag group

get
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
groupIdstringrequired
Query parameters
pageinteger · int32optional
sizeinteger · int32optional
sortstringoptional
searchstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups/{groupId}/resources' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

  • Common APIs
  • POST/us-v1/{menu}/{vendor}/grid-headers/{viewType}
  • Elastic Search Filter APIs
  • PUTFilter Data Quick Search For Usage
  • Optimization Detail V3 APIs
  • POSTOptimization Grid View
  • POSTOptimization Grid View
  • POSTOptimization Chart View
  • Optimization Setting V3 APIs
  • PUTReset resource optimization settings conditions
  • GETView list of support resources by optimization type
  • GETView list of resource optimization settings conditions
  • GETView list of resource optimization excluded tags
  • GETSearch for optimization rule set ID of the site and company
  • Resource Optimization APIs
  • PUTView top filter area by vendor
  • POSTLast optimization date lookup
  • POSTView top card area by optimization category
  • POSTPerform resource-optimized batch tasks
  • Resource Usage APIs
  • POSTUsage History Grid Data
  • POSTUsage Current Grid Data
  • POSTUsage Current Chart Data
  • POSTUsage History Chart Data
  • TagManager APIs
  • POSTGet tagKeys by accIds
  • POSTGet tagKeyVals
  • POSTTag modification tasks (addition, deletion, and modification)
  • POSTProvide a list of tag keys for deletion
  • POSTTag key modification tasks
  • POSTGet tags
  • POSTGet resources
  • POSTGet resources by tags
  • POSTGet tagGroups
  • GETGet tagKeys
  • GETGet tagKeyVals
  • GETGet tag statistics
  • GETGet tag statistics
  • GETGet AWS resource required tags
  • GETGet resources for a specific tag group
post
Authorizations
Path parameters
menustringrequired

menu

Example: usage
vendorstringrequired

vendor

Example: aws
viewTypestringrequired

view type

Example: history
Body
cmpnIdstringrequired

Company id

Example: 1
rsrcTypestringoptional

Resource Type

Example: ec2
vendorstringoptional

Vendor

Example: aws
viewTypestringoptional

View Type(current, history)

Example: history
menustringoptional

menu

Example: usage
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/{menu}/{vendor}/grid-headers/{viewType}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "rsrcType": "ec2",
    "vendor": "aws",
    "viewType": "history",
    "menu": "usage"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Filter Data Quick Search For Usage

put

View Filter Data Quick Search For Usage

Authorizations
Path parameters
menuIdstringrequired

Menu Id

Example: usage
Body
cmpnIdstringrequired

Company id

Example: 1
actionTypestringrequired

Action Type(current, history)

Example: current
keyListobject[]required

ES Search Key List

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/asset/us-v1/elastic/filter/{menuId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "actionType": "current",
    "keyList": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ]
  }'
200
{
  "result": {
    "vendors": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "accounts": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "regions": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "products": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "svcGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ],
    "tags": [
      {
        "vndr": "aws",
        "key": "Name",
        "value": "test",
        "isRequired": true
      }
    ],
    "tagGrps": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ]
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Optimization Grid View

post

Grid detail data inquiry according to optimization category and resource type

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
optimizeCategorystring · enumrequired
Available options:
accountIdstringrequired
Example: 000000000000
regionIdstringrequired
Example: ap-northeast-2
instanceIdstringrequired
Example: vol-00000
resourceTypestringrequired
Example: ebs
vendorstring · enumrequired
Example: aws
Available options:
recommendstringrequired
Example: idle
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/detail/list/info' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "optimizeCategory": "right-sizing",
    "accountId": "000000000000",
    "regionId": "ap-northeast-2",
    "instanceId": "vol-00000",
    "resourceType": "ebs",
    "vendor": "aws",
    "recommend": "idle"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Optimization Grid View

post

Grid data inquiry according to optimization category and resource type

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
optimizeCategorystring · enumrequired

Optimization category

Available options:
resourceTypestringrequired

Resource type

Example: ec2
vendorstring · enumrequired

Cloud vendor

Available options:
accountListstring[]optional

List of accounts to filter optimization results for

regionListstring[]optional

List of regions to filter optimization results for

serviceGroupListstring[]optional

List of serviceGroups to filter optimization results for

tagListobject[]optional

List of tags to filter optimization results for

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/detail/list' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "optimizeCategory": "right-sizing",
    "resourceType": "ec2",
    "vendor": "aws",
    "accountList": [
      "text"
    ],
    "regionList": [
      "text"
    ],
    "serviceGroupList": [
      "text"
    ],
    "tagList": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ]
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Optimization Chart View

post

View optimization charts by optimization category and resource type

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
optimizeCategorystring · enumrequired

Optimization category

Available options:
resourceTypestringrequired

Resource type

Example: ec2
vendorstring · enumrequired

Cloud vendor

Available options:
accountListstring[]optional

List of accounts to filter optimization results for

regionListstring[]optional

List of regions to filter optimization results for

serviceGroupListstring[]optional

List of serviceGroups to filter optimization results for

tagListobject[]optional

List of tags to filter optimization results for

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/detail/chart' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "optimizeCategory": "right-sizing",
    "resourceType": "ec2",
    "vendor": "aws",
    "accountList": [
      "text"
    ],
    "regionList": [
      "text"
    ],
    "serviceGroupList": [
      "text"
    ],
    "tagList": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ]
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Reset resource optimization settings conditions

put

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

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumrequired

Vendor

Available options:
resourceTypestringrequired

Resource Type

Example: ec2
optimizeCategorystring · enumrequired

Optimization category

Example: right-sizing
Available options:
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/setting/reset' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "resourceType": "ec2",
    "optimizeCategory": "right-sizing"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

View top filter area by vendor

put

Search the top filter area data for each vendor.

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
actionTypestringrequired

Action Type(current, history)

Example: current
keyListobject[]required

ES Search Key List

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/summary/filter' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "actionType": "current",
    "keyList": [
      {
        "vndr": "aws",
        "key": "vendors",
        "value": "aws",
        "selectYn": "enabled"
      }
    ]
  }'
200
{
  "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"
  }
}

OK

Last optimization date lookup

post

Queries the last time resource optimization was performed.

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
optimizeCategorystring · enumrequired

Optimization category

Available options:
resourceTypestringrequired

Resource type

Example: ec2
vendorstring · enumrequired

Cloud vendor

Available options:
accountListstring[]optional

List of accounts to filter optimization results for

regionListstring[]optional

List of regions to filter optimization results for

serviceGroupListstring[]optional

List of serviceGroups to filter optimization results for

tagListobject[]optional

List of tags to filter optimization results for

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/summary/last-execute' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "optimizeCategory": "right-sizing",
    "resourceType": "ec2",
    "vendor": "aws",
    "accountList": [
      "text"
    ],
    "regionList": [
      "text"
    ],
    "serviceGroupList": [
      "text"
    ],
    "tagList": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ]
  }'
200
{
  "data": {
    "lastExecuteDate": "2025-04-02T16:59:22.858Z"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

View top card area by optimization category

post

Search the top card area data for each optimization category.

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
optimizeCategorystring · enumrequired

Optimization category

Available options:
resourceTypestringrequired

Resource type

Example: ec2
vendorstring · enumrequired

Cloud vendor

Available options:
accountListstring[]optional

List of accounts to filter optimization results for

regionListstring[]optional

List of regions to filter optimization results for

serviceGroupListstring[]optional

List of serviceGroups to filter optimization results for

tagListobject[]optional

List of tags to filter optimization results for

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/summary/card' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "optimizeCategory": "right-sizing",
    "resourceType": "ec2",
    "vendor": "aws",
    "accountList": [
      "text"
    ],
    "regionList": [
      "text"
    ],
    "serviceGroupList": [
      "text"
    ],
    "tagList": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ]
  }'
200
{
  "data": [
    {
      "resourceType": "text",
      "expectedSavingCost": 1,
      "expectedSavingCount": 1
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Perform resource-optimized batch tasks

post

Perform resource-optimized batch tasks manually.

Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/optimization/general/analysis' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Usage History Grid Data

post

View History Usage Grid Data

Authorizations
Path parameters
prvrCdstring · enumrequired

Vendor

Example: aws
Available options:
Body
cmpnIdstringrequired

Company id

Example: 1
limitCntinteger · int32 · min: 1optional

Page Limit Count

Example: 1
pageNuminteger · int32 · min: 1optional

Page Number Count

Example: 1
offsetinteger · int32optional

Page Offset

Example: 1
totalCntinteger · int32optional

Page Total Count

Example: 1
fromstringrequired

From Date

Example: 2024-09-11
tostringrequired

To Date

Example: 2024-09-25
sortColIdstringrequired

Sort Column ID

Example: histDt
sortDirectionstringrequired

Sort Direction

Example: desc
excelYnstringrequired

Whether to download Excel

Example: N
rsrcTypestringrequired

Resource Type

Example: ec2
prvrCdstringrequired

Vendor

Example: aws
isGetHeaderstringoptional

Header or not

Example: Y
viewTypestringrequired

View Type(hour, day, week, month)

Example: day
langCdstringoptional

Language Code

Example: en
hasHistoryViewbooleanoptional

Whether to check history or not

Example: true
searchTextstringoptional

Search Text

Example: test
fieldListstring[]optional

Field List

regionsstring[]optional

Regions

svcGrpsstring[]optional

Service Groups

accountsstring[]optional

Accounts

tagsobject[]optional

Tags

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/history' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "limitCnt": 1,
    "pageNum": 1,
    "offset": 1,
    "totalCnt": 1,
    "from": "2024-09-11",
    "to": "2024-09-25",
    "sortColId": "histDt",
    "sortDirection": "desc",
    "excelYn": "N",
    "rsrcType": "ec2",
    "prvrCd": "aws",
    "isGetHeader": "Y",
    "viewType": "day",
    "langCd": "en",
    "hasHistoryView": true,
    "searchText": "test",
    "fieldList": [
      "text"
    ],
    "regions": [
      "text"
    ],
    "svcGrps": [
      "text"
    ],
    "accounts": [
      "text"
    ],
    "tags": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ]
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Usage Current Grid Data

post

View Current Usage Grid Data

Authorizations
Path parameters
prvrCdstring · enumrequired

Vendor

Example: aws
Available options:
Body
cmpnIdstringrequired

Company id

Example: 1
rgnIdstringoptional

Region Id

Example: ap-northeast-2
limitCntinteger · int32optional

Page Limit Count

Example: 1
pageNuminteger · int32optional

Page Number Count

Example: 1
offsetinteger · int32optional

Page Offset

Example: 1
totalCntinteger · int32optional

Page Total Count

Example: 1
sortColIdstringoptional

Sort Column ID

Example: seq
sortDirectionstringoptional

Sort Direction

Example: desc
excelYnstringoptional

Whether to download Excel

Example: N
rsrcTypestringrequired

Resource Type

Example: ec2
prvrCdstringrequired

Vendor

Example: aws
viewTypestringoptional

View Type(hour, day, week, month)

Example: day
fromstringoptional

From Date

Example: 2024-09-11
tostringoptional

To Date

Example: 2024-09-25
searchTextstringoptional

Search Text

Example: test
isGetHeaderstringoptional

Header or not

Example: Y
fieldListstring[]optional

Field List

regionsstring[]optional

Regions

svcGrpsstring[]optional

Service Groups

accountsstring[]optional

Accounts

tagsobject[]optional

Tags

svcGrpViewstringoptional

Service Group View Id

Example: Default
langCdstringoptional

Language Code

Example: en
rsrcSeqstringoptional

Resource Seq

Example: 0
headerTypestringoptional

Header Type

Example: single
isResourcestringoptional

Resource or Not

Example: N
rsrcNmstringoptional

Resource Name

Example: test
hasHistoryViewbooleanoptional

Whether to check history or not

Example: true
delChkstringoptional

Whether to exclude deleted resources

Example: Y
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/grid/current' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "rgnId": "ap-northeast-2",
    "limitCnt": 1,
    "pageNum": 1,
    "offset": 1,
    "totalCnt": 1,
    "sortColId": "seq",
    "sortDirection": "desc",
    "excelYn": "N",
    "rsrcType": "ec2",
    "prvrCd": "aws",
    "viewType": "day",
    "from": "2024-09-11",
    "to": "2024-09-25",
    "searchText": "test",
    "isGetHeader": "Y",
    "fieldList": [
      "text"
    ],
    "regions": [
      "text"
    ],
    "svcGrps": [
      "text"
    ],
    "accounts": [
      "text"
    ],
    "tags": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ],
    "svcGrpView": "Default",
    "langCd": "en",
    "rsrcSeq": "0",
    "headerType": "single",
    "isResource": "N",
    "rsrcNm": "test",
    "hasHistoryView": true,
    "delChk": "Y"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Usage Current Chart Data

post

View Current Usage Chart Data

Authorizations
Path parameters
prvrCdstring · enumrequired

Vendor

Example: aws
Available options:
Body
cmpnIdstringrequired

Company id

Example: 1
rsrcTypestringrequired

Resource Type

Example: ec2
prvrCdstringrequired

Vendor

Example: aws
rsrcNmstringoptional

Resource Name

Example: test
regionsstring[]optional

Regions

svcGrpsstring[]optional

Service Groups

accountsstring[]optional

Accounts

tagsobject[]optional

Tags

reqTypestringoptional
delChkstringoptional

Whether to exclude deleted resources

Example: Y
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/pie/current' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "rsrcType": "ec2",
    "prvrCd": "aws",
    "rsrcNm": "test",
    "regions": [
      "text"
    ],
    "svcGrps": [
      "text"
    ],
    "accounts": [
      "text"
    ],
    "tags": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ],
    "reqType": "text",
    "delChk": "Y"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Usage History Chart Data

post

View History Usage Chart Data

Authorizations
Path parameters
prvrCdstring · enumrequired

Vendor

Example: aws
Available options:
Body
cmpnIdstringrequired

Company id

Example: 1
fromstringrequired

From Date

Example: 2024-09-11
tostringrequired

To Date

Example: 2024-09-25
rsrcTypestringrequired

Resource Type

Example: ec2
prvrCdstringrequired

Vendor

Example: aws
regionsstring[]optional

Regions

svcGrpsstring[]optional

Service Groups

accountsstring[]optional

Accounts

tagsobject[]optional

Tags

viewTypestringrequired

View Type(hour, day, week, month)

Example: day
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/usage/{prvrCd}/chart/history' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "from": "2024-09-11",
    "to": "2024-09-25",
    "rsrcType": "ec2",
    "prvrCd": "aws",
    "regions": [
      "text"
    ],
    "svcGrps": [
      "text"
    ],
    "accounts": [
      "text"
    ],
    "tags": [
      {
        "key": "Name",
        "value": [
          "text"
        ]
      }
    ],
    "viewType": "day"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tagKeys by accIds

post

Get tag keys for specified AWS account IDs

Authorizations
Path parameters
vendorstringrequired
Body
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
accIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/vendors/{vendor}/tag-keys' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "accIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tagKeyVals

post
Authorizations
Path parameters
vendorstringrequired
tagKeystringrequired
Body
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
accIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/vendors/{vendor}/tag-keys/{tagKey}/tag-vals' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "accIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Tag modification tasks (addition, deletion, and modification)

post
Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
updateTypestringoptional
tagListobject[]optional

resourceListobject[]optional

replacementValuestringoptional
userEmailstringoptional
vendorstring · enumoptional
Available options:
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/update-tag' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "updateType": "text",
    "tagList": [
      {
        "tagKey": "text",
        "tagVal": "text",
        "creaDt": "2025-04-02T16:59:22.858Z",
        "instId": "text",
        "state": "text",
        "tagVals": [
          "text"
        ]
      }
    ],
    "resourceList": [
      {
        "accId": "text",
        "rgnId": "text",
        "rsrcType": "text",
        "instId": "text",
        "arn": "text",
        "resourceGroupTaggingYn": "text",
        "existTags": [
          {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        ],
        "sbscId": "text",
        "rsrcGrp": "text",
        "id": "text",
        "nrn": "text"
      }
    ],
    "replacementValue": "text",
    "userEmail": "text",
    "vendor": "aws"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Provide a list of tag keys for deletion

post
Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumoptional
Available options:
dataobject[]optional

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/resources/tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "data": [
      {
        "accId": "text",
        "rsrcType": "text",
        "rgnId": "text",
        "instId": "text",
        "tagKey": "text"
      }
    ]
  }'
200
{
  "result": [
    {
      "tagKey": "text",
      "tagValue": [
        "text"
      ],
      "isCommon": true
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Tag key modification tasks

post
Authorizations
Body
cmpnIdstringrequired

Company id

Example: 1
tagKeystringoptional
tagKeysstring[]optional
renameTagKeystringoptional
userEmailstringoptional
vendorstring · enumoptional
Available options:
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/rename-tag-key' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "tagKey": "text",
    "tagKeys": [
      "text"
    ],
    "renameTagKey": "text",
    "userEmail": "text",
    "vendor": "aws"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tags

post
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
emptyDataFlagbooleanoptional
accIdstringoptional
accIdsstring[]optional
rgnIdstringoptional
rgnIdsstring[]optional
instIdstringoptional
instIdsstring[]optional
rsrcTypestringoptional
rsrcTypesstring[]optional
tagKeysstring[]optional
tagTypestringoptional
tagTypesstring[]optional
tagTypeConditionstringoptional
tagsobject[]optional

compliantTypestringoptional
compliantTypesstring[]optional
groupIdstringoptional
groupIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
tagSortstringoptional
sortTagKeystringoptional
searchstringoptional
noValueYnstringoptional
tagYnstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "emptyDataFlag": true,
    "accId": "text",
    "accIds": [
      "text"
    ],
    "rgnId": "text",
    "rgnIds": [
      "text"
    ],
    "instId": "text",
    "instIds": [
      "text"
    ],
    "rsrcType": "text",
    "rsrcTypes": [
      "text"
    ],
    "tagKeys": [
      "text"
    ],
    "tagType": "text",
    "tagTypes": [
      "text"
    ],
    "tagTypeCondition": "text",
    "tags": [
      {
        "tagKey": "text",
        "tagVal": "text",
        "creaDt": "2025-04-02T16:59:22.858Z",
        "instId": "text",
        "state": "text",
        "tagVals": [
          "text"
        ]
      }
    ],
    "compliantType": "text",
    "compliantTypes": [
      "text"
    ],
    "groupId": "text",
    "groupIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text",
    "tagSort": "text",
    "sortTagKey": "text",
    "search": "text",
    "noValueYn": "text",
    "tagYn": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get resources

post
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
emptyDataFlagbooleanoptional
accIdstringoptional
accIdsstring[]optional
rgnIdstringoptional
rgnIdsstring[]optional
instIdstringoptional
instIdsstring[]optional
rsrcTypestringoptional
rsrcTypesstring[]optional
tagKeysstring[]optional
tagTypestringoptional
tagTypesstring[]optional
tagTypeConditionstringoptional
tagsobject[]optional

compliantTypestringoptional
compliantTypesstring[]optional
groupIdstringoptional
groupIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
tagSortstringoptional
sortTagKeystringoptional
searchstringoptional
noValueYnstringoptional
tagYnstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "emptyDataFlag": true,
    "accId": "text",
    "accIds": [
      "text"
    ],
    "rgnId": "text",
    "rgnIds": [
      "text"
    ],
    "instId": "text",
    "instIds": [
      "text"
    ],
    "rsrcType": "text",
    "rsrcTypes": [
      "text"
    ],
    "tagKeys": [
      "text"
    ],
    "tagType": "text",
    "tagTypes": [
      "text"
    ],
    "tagTypeCondition": "text",
    "tags": [
      {
        "tagKey": "text",
        "tagVal": "text",
        "creaDt": "2025-04-02T16:59:22.858Z",
        "instId": "text",
        "state": "text",
        "tagVals": [
          "text"
        ]
      }
    ],
    "compliantType": "text",
    "compliantTypes": [
      "text"
    ],
    "groupId": "text",
    "groupIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text",
    "tagSort": "text",
    "sortTagKey": "text",
    "search": "text",
    "noValueYn": "text",
    "tagYn": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get resources by tags

post
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
emptyDataFlagbooleanoptional
accIdstringoptional
accIdsstring[]optional
rgnIdstringoptional
rgnIdsstring[]optional
instIdstringoptional
instIdsstring[]optional
rsrcTypestringoptional
rsrcTypesstring[]optional
tagKeysstring[]optional
tagTypestringoptional
tagTypesstring[]optional
tagTypeConditionstringoptional
tagsobject[]optional

compliantTypestringoptional
compliantTypesstring[]optional
groupIdstringoptional
groupIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
tagSortstringoptional
sortTagKeystringoptional
searchstringoptional
noValueYnstringoptional
tagYnstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources-by-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "emptyDataFlag": true,
    "accId": "text",
    "accIds": [
      "text"
    ],
    "rgnId": "text",
    "rgnIds": [
      "text"
    ],
    "instId": "text",
    "instIds": [
      "text"
    ],
    "rsrcType": "text",
    "rsrcTypes": [
      "text"
    ],
    "tagKeys": [
      "text"
    ],
    "tagType": "text",
    "tagTypes": [
      "text"
    ],
    "tagTypeCondition": "text",
    "tags": [
      {
        "tagKey": "text",
        "tagVal": "text",
        "creaDt": "2025-04-02T16:59:22.858Z",
        "instId": "text",
        "state": "text",
        "tagVals": [
          "text"
        ]
      }
    ],
    "compliantType": "text",
    "compliantTypes": [
      "text"
    ],
    "groupId": "text",
    "groupIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text",
    "tagSort": "text",
    "sortTagKey": "text",
    "search": "text",
    "noValueYn": "text",
    "tagYn": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK

Get tagGroups

post
Authorizations
Path parameters
cmpnIdstringrequired
vendorstringrequired
Body
cmpnIdstringrequired

Company id

Example: 1
vendorstring · enumoptional
Available options:
pageinteger · int32optional
sizeinteger · int32 · max: 1000optional
offsetinteger · int32optional
emptyDataFlagbooleanoptional
accIdstringoptional
accIdsstring[]optional
rgnIdstringoptional
rgnIdsstring[]optional
instIdstringoptional
instIdsstring[]optional
rsrcTypestringoptional
rsrcTypesstring[]optional
tagKeysstring[]optional
tagTypestringoptional
tagTypesstring[]optional
tagTypeConditionstringoptional
tagsobject[]optional

compliantTypestringoptional
compliantTypesstring[]optional
groupIdstringoptional
groupIdsstring[]optional
sortstringoptional
sortColIdstringoptional
sortDirectionstringoptional
tagSortstringoptional
sortTagKeystringoptional
searchstringoptional
noValueYnstringoptional
tagYnstringoptional
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.opsnow.io/asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "cmpnId": "1",
    "vendor": "aws",
    "page": 1,
    "size": 1,
    "offset": 1,
    "emptyDataFlag": true,
    "accId": "text",
    "accIds": [
      "text"
    ],
    "rgnId": "text",
    "rgnIds": [
      "text"
    ],
    "instId": "text",
    "instIds": [
      "text"
    ],
    "rsrcType": "text",
    "rsrcTypes": [
      "text"
    ],
    "tagKeys": [
      "text"
    ],
    "tagType": "text",
    "tagTypes": [
      "text"
    ],
    "tagTypeCondition": "text",
    "tags": [
      {
        "tagKey": "text",
        "tagVal": "text",
        "creaDt": "2025-04-02T16:59:22.858Z",
        "instId": "text",
        "state": "text",
        "tagVals": [
          "text"
        ]
      }
    ],
    "compliantType": "text",
    "compliantTypes": [
      "text"
    ],
    "groupId": "text",
    "groupIds": [
      "text"
    ],
    "sort": "text",
    "sortColId": "text",
    "sortDirection": "text",
    "tagSort": "text",
    "sortTagKey": "text",
    "search": "text",
    "noValueYn": "text",
    "tagYn": "text"
  }'
200
{
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

OK