Get license usage details

Obtains the license usage count of cloud resources.

Get license usage details

Request details

HTTP method: GET

Request URL: https://<host_name>/cloudcost/api/v1/license/usage/

Example: https://portal.us1.onbmc.com/cloudcost/api/v1/license/usage/

Headers:

Property	Value	Required	Description
Content-Type	application/json	Yes	Accepted content type.
Authorization	JWT Token	Yes	Used for authentication.

Query parameters:

Property	Type	Required	Description
start	String	Yes	The month (in the MMYYYY format) from when you want to view the license usage.
end	String	Yes	The month (in the MMYYYY format) up to when you want to view the license usage.
provider	ENUM	No	Optionally, get the license usage details for a specified provider.
daily	Boolean	No	Indicates whether you want to retrieve the daily count of license usage. The default is false.

Sample response

Sample response 1 - Average monthly usage

[
    {
       "timestamp": 1622509200, # Monthly average for June 2021
       "count": 1000
    },
    {
       "timestamp": 1625101200, # Monthly average for July 2021
       "count": 1000
    }
]

Sample response 2 - Timeseries usage

[
   {
       "timestamp": 1625101200, # 01 July 2021
       "count": 100
   },
   {
       "timestamp": 1625187600, # 02 July 2021
       "count": 150
   },
   {
       "timestamp": 1625274000, # 03 July 2021
       "count": 106
   },
    ...
]

Status codes and messages

HTTP code	Description
200	OK
401	Unauthorized
400	Bad request
403	Forbidden

Get license usage details