Resources

Common APIs

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

menustringRequired

menu

Example: usage

vendorstringRequired

vendor

Example: aws

viewTypestringRequired

view type

Example: history

Body

application/json

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

200

OK

*/*

post

/us-v1/{menu}/{vendor}/grid-headers/{viewType}

HTTPcURLJavaScriptPython

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

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

200

OK

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

Elastic Search Filter APIs

Filter Data Quick Search For Usage

put

View Filter Data Quick Search For Usage

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

menuIdstringRequired

Menu Id

Example: usage

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

actionTypestringRequired

Action Type(current, history)

Example: current

Responses

200

OK

*/*

put

/us-v1/elastic/filter/{menuId}

HTTPcURLJavaScriptPython

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

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

200

OK

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

Optimization Detail V3 APIs

Optimization Grid View

post

Grid detail data inquiry according to optimization category and resource type

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequiredPossible values:

accountIdstringRequiredExample: 000000000000

regionIdstringRequiredExample: ap-northeast-2

instanceIdstringRequiredExample: vol-00000

resourceTypestringRequiredExample: ebs

vendorstring · enumRequiredExample: awsPossible values:

recommendstringRequiredExample: idle

Responses

200

OK

*/*

post

/us-v1/optimization/detail/list/info

HTTPcURLJavaScriptPython

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

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

200

OK

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

Optimization Grid View

post

Grid data inquiry according to optimization category and resource type

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

OK

*/*

post

/us-v1/optimization/detail/list

HTTPcURLJavaScriptPython

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

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

200

OK

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

Optimization Chart View

post

View optimization charts by optimization category and resource type

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

OK

*/*

post

/us-v1/optimization/detail/chart

HTTPcURLJavaScriptPython

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

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

200

OK

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

Optimization Setting V3 APIs

Reset resource optimization settings conditions

put

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumRequired

Vendor

Possible values:

resourceTypestringRequired

Resource Type

Example: ec2

optimizeCategorystring · enumRequired

Optimization category

Example: right-sizingPossible values:

Responses

200

OK

*/*

put

/us-v1/optimization/setting/reset

HTTPcURLJavaScriptPython

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

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

200

OK

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

View list of support resources by optimization type

get

View list of support resources by optimization type

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

optimizeCategorystring · enumRequired

Optimization category

Possible values:

Responses

200

OK

*/*

get

/us-v1/optimization/setting/optimize-category/{optimizeCategory}

HTTPcURLJavaScriptPython

GET /asset/us-v1/optimization/setting/optimize-category/{optimizeCategory} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "result": [
    {
      "vendor": "text",
      "resourceType": "text",
      "resourceName": "text"
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

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

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

Company Id

Example: 1

vendorstring · enumRequired

Vendor

Possible values:

optimizeCategorystring · enumRequired

Optimization category

Possible values:

ruleSetIdstringRequired

Rule id

Query parameters

resourceTypestringOptional

Resource type

Example: ec2

Responses

200

OK

*/*

get

/us-v1/optimization/setting/companies/{cmpnId}/vendors/{vendor}/optimize-category/{optimizeCategory}/rule-sets/{ruleSetId}

HTTPcURLJavaScriptPython

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

200

OK

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

View list of resource optimization excluded tags

get

View the list of tags excluded from resource optimization.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

Company unique ID

ruleSetIdstringRequired

Rule id

Example: Default

Responses

200

OK

*/*

get

/us-v1/optimization/setting/companies/{cmpnId}/rule-sets/{ruleSetId}/deny

HTTPcURLJavaScriptPython

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

200

OK

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

Search for optimization rule set ID of the site and company

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

Company Id

Example: 1

Responses

200

OK

*/*

get

/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id

HTTPcURLJavaScriptPython

GET /asset/us-v1/optimization/setting/companies/{cmpnId}/rule-set-id HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Resource Optimization APIs

View top filter area by vendor

put

Search the top filter area data for each vendor.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

actionTypestringRequired

Action Type(current, history)

Example: current

Responses

200

OK

*/*

put

/us-v1/optimization/summary/filter

HTTPcURLJavaScriptPython

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

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

200

OK

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

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vndrListstring[]Optional

analyYnstringOptional

idleSetIdstringOptional

idleSetNmstringOptional

pageNuminteger · int32Optional

limitCntinteger · int32Optional

offsetinteger · int32Optional

searchTextstringOptional

typestringOptional

sortIdstringOptional

sortOrderstringOptional

currentRuleSetstringOptional

gridTypestringOptional

listTypestringOptional

rsrcTypestringOptional

excelYnstringOptional

todaystringOptional

bzListstring[]Optional

awsAccListstring[]Optional

awsRgnListstring[]Optional

azuAccListstring[]Optional

azuRgnListstring[]Optional

aliAccListstring[]Optional

aliRgnListstring[]Optional

gcpAccListstring[]Optional

gcpRgnListstring[]Optional

ncpAccListstring[]Optional

ncpRgnListstring[]Optional

chartTypestringOptional

rcmdstringOptional

currentCostnumber · doubleOptional

addRcmdGrpstringOptional

tzstringOptional

rcmdListstring[]Optional

cmpnNmstringOptional

rprtTypestringOptional

rprtTitleNamestringOptional

rprtFlagstringOptional

rprtSbscIdstringOptional

bzGrpSetIdstringOptional

svcGrpListstring[]Optional

Responses

200

OK

No content

post

/us-v1/optimization/summary/report-download

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vndrList": [
    "text"
  ],
  "analyYn": "text",
  "idleSetId": "text",
  "idleSetNm": "text",
  "pageNum": 1,
  "limitCnt": 1,
  "offset": 1,
  "searchText": "text",
  "type": "text",
  "sortId": "text",
  "sortOrder": "text",
  "currentRuleSet": "text",
  "gridType": "text",
  "listType": "text",
  "rsrcType": "text",
  "excelYn": "text",
  "today": "text",
  "bzList": [
    "text"
  ],
  "awsAccList": [
    "text"
  ],
  "awsRgnList": [
    "text"
  ],
  "azuAccList": [
    "text"
  ],
  "azuRgnList": [
    "text"
  ],
  "aliAccList": [
    "text"
  ],
  "aliRgnList": [
    "text"
  ],
  "gcpAccList": [
    "text"
  ],
  "gcpRgnList": [
    "text"
  ],
  "ncpAccList": [
    "text"
  ],
  "ncpRgnList": [
    "text"
  ],
  "chartType": "text",
  "rcmd": "text",
  "currentCost": 1,
  "addRcmdGrp": "text",
  "tz": "text",
  "rcmdList": [
    "text"
  ],
  "cmpnNm": "text",
  "rprtType": "text",
  "rprtTitleName": "text",
  "rprtFlag": "text",
  "rprtSbscId": "text",
  "rsrcList": [
    {
      "cnt": 1,
      "rsrcType": "text",
      "vndr": "text"
    }
  ],
  "bzGrpSetId": "text",
  "svcGrpList": [
    "text"
  ]
}

200

OK

No content

Last optimization date lookup

post

Queries the last time resource optimization was performed.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

OK

*/*

post

/us-v1/optimization/summary/last-execute

HTTPcURLJavaScriptPython

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

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

200

OK

{
  "data": {
    "lastExecuteDate": "2025-12-12T23:21:35.167Z"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

View top card area by optimization category

post

Search the top card area data for each optimization category.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

OK

*/*

post

/us-v1/optimization/summary/card

HTTPcURLJavaScriptPython

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

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

200

OK

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

View optimization summary information for vendors

post

Search the optimization summary information for each vendor.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

optimizeCategorystring · enumRequired

Optimization category

Possible values:

resourceTypestringRequired

Resource type

Example: ec2

vendorstring · enumRequired

Cloud vendor

Possible values:

accountListstring[]Optional

List of accounts to filter optimization results for

regionListstring[]Optional

List of regions to filter optimization results for

serviceGroupListstring[]Optional

List of serviceGroups to filter optimization results for

Responses

200

OK

*/*

post

/us-v1/optimization/summary

HTTPcURLJavaScriptPython

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

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

200

OK

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

Perform resource-optimized batch tasks

post

Perform resource-optimized batch tasks manually.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

Responses

200

OK

*/*

post

/us-v1/optimization/general/analysis

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1"
}

200

OK

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

Resource Usage APIs

Usage History Grid Data

post

View History Usage Grid Data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

limitCntinteger · int32 · min: 1Optional

Page Limit Count

Example: 1

pageNuminteger · int32 · min: 1Optional

Page Number Count

Example: 1

offsetinteger · int32Optional

Page Offset

Example: 1

totalCntinteger · int32Optional

Page Total Count

Example: 1

fromstringRequired

From Date

Example: 2024-09-11

tostringRequired

To Date

Example: 2024-09-25

sortColIdstringRequired

Sort Column ID

Example: histDt

sortDirectionstringRequired

Sort Direction

Example: desc

excelYnstringRequired

Whether to download Excel

Example: N

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

isGetHeaderstringOptional

Header or not

Example: Y

viewTypestringRequired

View Type(hour, day, week, month)

Example: day

langCdstringOptional

Language Code

Example: en

hasHistoryViewbooleanOptional

Whether to check history or not

Example: true

searchTextstringOptional

Search Text

Example: test

fieldListstring[]Optional

Field List

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

Responses

200

OK

*/*

post

/us-v1/usage/{prvrCd}/grid/history

HTTPcURLJavaScriptPython

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

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

200

OK

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

Usage Current Grid Data

post

View Current Usage Grid Data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

rgnIdstringOptional

Region Id

Example: ap-northeast-2

limitCntinteger · int32Optional

Page Limit Count

Example: 1

pageNuminteger · int32Optional

Page Number Count

Example: 1

offsetinteger · int32Optional

Page Offset

Example: 1

totalCntinteger · int32Optional

Page Total Count

Example: 1

sortColIdstringOptional

Sort Column ID

Example: seq

sortDirectionstringOptional

Sort Direction

Example: desc

excelYnstringOptional

Whether to download Excel

Example: N

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

viewTypestringOptional

View Type(hour, day, week, month)

Example: day

fromstringOptional

From Date

Example: 2024-09-11

tostringOptional

To Date

Example: 2024-09-25

searchTextstringOptional

Search Text

Example: test

isGetHeaderstringOptional

Header or not

Example: Y

fieldListstring[]Optional

Field List

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

svcGrpViewstringOptional

Service Group View Id

Example: Default

langCdstringOptional

Language Code

Example: en

rsrcSeqstringOptional

Resource Seq

Example: 0

headerTypestringOptional

Header Type

Example: single

isResourcestringOptional

Resource or Not

Example: N

rsrcNmstringOptional

Resource Name

Example: test

hasHistoryViewbooleanOptional

Whether to check history or not

Example: true

delChkstringOptional

Whether to exclude deleted resources

Example: Y

Responses

200

OK

*/*

post

/us-v1/usage/{prvrCd}/grid/current

HTTPcURLJavaScriptPython

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

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

200

OK

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

Usage Current Chart Data

post

View Current Usage Chart Data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

rsrcNmstringOptional

Resource Name

Example: test

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

reqTypestringOptional

delChkstringOptional

Whether to exclude deleted resources

Example: Y

Responses

200

OK

*/*

post

/us-v1/usage/{prvrCd}/chart/pie/current

HTTPcURLJavaScriptPython

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

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

200

OK

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

Usage History Chart Data

post

View History Usage Chart Data

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

prvrCdstring · enumRequired

Vendor

Example: awsPossible values:

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

fromstringRequired

From Date

Example: 2024-09-11

tostringRequired

To Date

Example: 2024-09-25

rsrcTypestringRequired

Resource Type

Example: ec2

prvrCdstringRequired

Vendor

Example: aws

regionsstring[]Optional

Regions

svcGrpsstring[]Optional

Service Groups

accountsstring[]Optional

Accounts

viewTypestringRequired

View Type(hour, day, week, month)

Example: day

Responses

200

OK

*/*

post

/us-v1/usage/{prvrCd}/chart/history

HTTPcURLJavaScriptPython

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

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

200

OK

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

TagManager APIs

Get tagKeys by accIds

post

Get tag keys for specified AWS account IDs

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

Body

application/json

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

accIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/vendors/{vendor}/tag-keys

HTTPcURLJavaScriptPython

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

{
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "accIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text"
}

200

OK

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

Get tagKeyVals

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

vendorstringRequired

tagKeystringRequired

Body

application/json

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

accIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/vendors/{vendor}/tag-keys/{tagKey}/tag-vals

HTTPcURLJavaScriptPython

POST /asset/us-v1/tag-manager/vendors/{vendor}/tag-keys/{tagKey}/tag-vals HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "accIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text"
}

200

OK

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

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

taggingIdstringOptional

undoIdstringOptional

userEmailstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/undo-tagging

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "taggingId": "text",
  "undoId": "text",
  "taggingResourceList": [
    {
      "accId": "text",
      "rgnId": "text",
      "rsrcType": "text",
      "instId": "text",
      "arn": "text",
      "resourceGroupTaggingYn": "text",
      "existTags": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "sbscId": "text",
      "rsrcGrp": "text",
      "id": "text",
      "nrn": "text",
      "reviewTagList": [
        {
          "tagKey": "text",
          "oldValue": "text",
          "newValue": "text"
        }
      ]
    }
  ],
  "userEmail": "text"
}

200

OK

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

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

taggingIdstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/tag-processing-status

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "taggingId": "text"
}

200

OK

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

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

taggingIdstringOptional

retryIdstringOptional

userEmailstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/retry-tagging

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "taggingId": "text",
  "retryId": "text",
  "taggingResourceList": [
    {
      "accId": "text",
      "rgnId": "text",
      "rsrcType": "text",
      "instId": "text",
      "arn": "text",
      "resourceGroupTaggingYn": "text",
      "existTags": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "sbscId": "text",
      "rsrcGrp": "text",
      "id": "text",
      "nrn": "text",
      "reviewTagList": [
        {
          "tagKey": "text",
          "oldValue": "text",
          "newValue": "text"
        }
      ]
    }
  ],
  "userEmail": "text"
}

200

OK

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

Provide a list of tag keys for deletion

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

Responses

200

OK

*/*

post

/us-v1/tag-manager/resources/tags

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "data": [
    {
      "accId": "text",
      "rsrcType": "text",
      "rgnId": "text",
      "instId": "text",
      "tagKey": "text"
    }
  ]
}

200

OK

{
  "result": [
    {
      "tagKey": "text",
      "tagValue": [
        "text"
      ],
      "isCommon": true
    }
  ],
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}

Deprecated

Get tags

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tags

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

Get tag statistics

post

Get tagging status and billing tag compliant

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

Get resources

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

listBillingTags

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources/email-export

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

Deprecated

Get resources by tags

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/resources-by-tags

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

Get tagGroups

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

pageinteger · int32Optional

sizeinteger · int32 · max: 1000Optional

offsetinteger · int32Optional

emptyDataFlagbooleanOptional

accIdstringOptional

accIdsstring[]Optional

rgnIdstringOptional

rgnIdsstring[]Optional

instIdstringOptional

instIdsstring[]Optional

rsrcTypestringOptional

rsrcTypesstring[]Optional

resourceGroupsstring[]Optional

tagKeysstring[]Optional

antiTagKeysstring[]Optional

tagTypestringOptional

tagTypesstring[]Optional

tagTypeConditionstringOptional

compliantTypestringOptional

compliantTypesstring[]Optional

groupIdstringOptional

groupIdsstring[]Optional

sortstringOptional

sortColIdstringOptional

sortDirectionstringOptional

tagSortstringOptional

sortTagKeystringOptional

searchstringOptional

taggingStatusstringOptional

taggingStatusesstring[]Optional

Responses

200

OK

*/*

post

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "page": 1,
  "size": 1,
  "offset": 1,
  "emptyDataFlag": true,
  "accId": "text",
  "accIds": [
    "text"
  ],
  "rgnId": "text",
  "rgnIds": [
    "text"
  ],
  "instId": "text",
  "instIds": [
    "text"
  ],
  "rsrcType": "text",
  "rsrcTypes": [
    "text"
  ],
  "resourceGroups": [
    "text"
  ],
  "tagKeys": [
    "text"
  ],
  "antiTagKeys": [
    "text"
  ],
  "tagType": "text",
  "tagTypes": [
    "text"
  ],
  "tagTypeCondition": "text",
  "tags": [
    {
      "tagKey": "text",
      "tagVal": "text",
      "creaDt": "2025-12-12T23:21:35.167Z",
      "instId": "text",
      "state": "text",
      "tagVals": [
        "text"
      ]
    }
  ],
  "compliantType": "text",
  "compliantTypes": [
    "text"
  ],
  "groupId": "text",
  "groupIds": [
    "text"
  ],
  "sort": "text",
  "sortColId": "text",
  "sortDirection": "text",
  "tagSort": "text",
  "sortTagKey": "text",
  "search": "text",
  "taggingStatus": "text",
  "taggingStatuses": [
    "text"
  ]
}

200

OK

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

Tag modification tasks (addition, deletion, and modification)

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

taggingIdstringOptional

userEmailstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/add-tag

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "taggingId": "text",
  "taggingResourceList": [
    {
      "accId": "text",
      "rgnId": "text",
      "rsrcType": "text",
      "instId": "text",
      "arn": "text",
      "resourceGroupTaggingYn": "text",
      "existTags": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "sbscId": "text",
      "rsrcGrp": "text",
      "id": "text",
      "nrn": "text",
      "reviewTagList": [
        {
          "tagKey": "text",
          "oldValue": "text",
          "newValue": "text"
        }
      ]
    }
  ],
  "userEmail": "text"
}

200

OK

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

Tag modification tasks (addition, deletion, and modification)

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vendorstring · enumOptionalPossible values:

taggingIdstringOptional

userEmailstringOptional

Responses

200

OK

*/*

post

/us-v1/tag-manager/update-tag

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vendor": "aws",
  "taggingId": "text",
  "taggingResourceList": [
    {
      "accId": "text",
      "rgnId": "text",
      "rsrcType": "text",
      "instId": "text",
      "arn": "text",
      "resourceGroupTaggingYn": "text",
      "existTags": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "sbscId": "text",
      "rsrcGrp": "text",
      "id": "text",
      "nrn": "text",
      "reviewTagList": [
        {
          "tagKey": "text",
          "oldValue": "text",
          "newValue": "text"
        }
      ]
    }
  ],
  "userEmail": "text"
}

200

OK

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

Get tagKeys

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Get tagKeyVals

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

tagKeystringRequired

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys/{tagKey}/tag-vals

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/tag-keys/{tagKey}/tag-vals HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Deprecated

Get tag statistics

get

Get tag compliance and status statistics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/tag

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/tag HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Deprecated

Get tag statistics

get

Get tag compliance and status statistics

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/resource

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/stats/resource HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Get resources for a specific tag group

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

groupIdstringRequired

Query parameters

pageinteger · int32Optional

sizeinteger · int32Optional

sortstringOptional

searchstringOptional

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups/{groupId}/resources

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/groups/{groupId}/resources HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Get AWS resource billing tags

get

Get required tags information for AWS

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

vendorstringRequired

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/billing-tags

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/vendors/{vendor}/billing-tags HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Provide a list of tag keys for deletion

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

Query parameters

vendorstringOptionalDefault: aws

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/histories

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/histories HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Provide a list of tag keys for deletion

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

cmpnIdstringRequired

historyIdstringRequired

Query parameters

vendorstringOptionalDefault: aws

Responses

200

OK

*/*

get

/us-v1/tag-manager/companies/{cmpnId}/histories/{historyId}

HTTPcURLJavaScriptPython

GET /asset/us-v1/tag-manager/companies/{cmpnId}/histories/{historyId} HTTP/1.1
Host: api.opsnow.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

rsrc-opti-common-controller APIs

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

cmpnIdstringRequired

Company id

Example: 1

vndrstringOptional

analyYnstringOptional

idleSetIdstringOptional

idleSetNmstringOptional

pageNuminteger · int32Optional

limitCntinteger · int32Optional

offsetinteger · int32Optional

searchTextstringOptional

typestringOptional

sortIdstringWrite-onlyOptional

sortOrderstringWrite-onlyOptional

currentRuleSetstringOptional

gridTypestringOptional

listTypestringOptional

rsrcTypestringOptional

excelYnstringOptional

todaystringOptional

accListstring[]Optional

bzListstring[]Optional

rgnListstring[]Optional

chartTypestringOptional

rcmdstringOptional

currentCostnumber · doubleOptional

addRcmdGrpstringOptional

tzstringOptional

rcmdListstring[]Optional

vndrListstring[]Optional

rprtFlagstringOptional

accOriginestringOptional

bzGrpSetIdstringOptional

batchYnstringOptional

rprtSbscCclstringOptional

rprtSbscCclRngstringOptional

utcTimeStampstringOptional

rprtSbscCclTimestringOptional

unusedRsrcTypesstringOptional

rightSizingRsrcTypesstringOptional

Responses

200

OK

*/*

post

/us-v1/rsrcopti/summary

HTTPcURLJavaScriptPython

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

{
  "cmpnId": "1",
  "vndr": "text",
  "analyYn": "text",
  "idleSetId": "text",
  "idleSetNm": "text",
  "pageNum": 1,
  "limitCnt": 1,
  "offset": 1,
  "searchText": "text",
  "type": "text",
  "sortId": "text",
  "sortOrder": "text",
  "currentRuleSet": "text",
  "gridType": "text",
  "listType": "text",
  "rsrcType": "text",
  "excelYn": "text",
  "today": "text",
  "accList": [
    "text"
  ],
  "bzList": [
    "text"
  ],
  "rgnList": [
    "text"
  ],
  "chartType": "text",
  "rcmd": "text",
  "currentCost": 1,
  "addRcmdGrp": "text",
  "tz": "text",
  "rcmdList": [
    "text"
  ],
  "vndrList": [
    "text"
  ],
  "rprtFlag": "text",
  "accOrigine": "text",
  "bzGrpSetId": "text",
  "batchYn": "text",
  "rprtSbscCcl": "text",
  "rprtSbscCclRng": "text",
  "utcTimeStamp": "text",
  "rprtSbscCclTime": "text",
  "unusedRsrcTypes": "text",
  "rightSizingRsrcTypes": "text"
}

200

OK

{
  "result": {
    "summaryTotalCost": {
      "currentCost": 1,
      "totalCost": 1,
      "unusedCost": 1,
      "rightSizingCost": 1,
      "totalCnt": 1,
      "unusedCnt": 1,
      "rightSizingCnt": 1
    },
    "gridSummary": {
      "unusedResource": {
        "totalCnt": 1,
        "cnt": 1,
        "cost": 1,
        "resource": {
          "ANY_ADDITIONAL_PROPERTY": {
            "rsrcType": "text",
            "totalCnt": 1,
            "cnt": 1,
            "cost": 1,
            "type": "text",
            "prodNm": "text",
            "apiNm": "text"
          }
        }
      },
      "rightSizing": {
        "totalCnt": 1,
        "cnt": 1,
        "cost": 1,
        "resource": {
          "ANY_ADDITIONAL_PROPERTY": {
            "rsrcType": "text",
            "totalCnt": 1,
            "cnt": 1,
            "cost": 1,
            "type": "text",
            "prodNm": "text",
            "apiNm": "text"
          }
        }
      }
    },
    "currency": "text",
    "cmpnId": "text"
  },
  "status": "text",
  "error": {
    "code": "text",
    "message": "text"
  }
}