Usage Service 1.0 (1.0.0)

Download OpenAPI specification:Download

Retrieve usage records for the Cloud One services that you've accessed.

Usage

Usage Records in Cloud One

Retrieve a Cloud One Account's usage records

get/usage

Provided a valid Cloud One API Key, returns the Cloud One usage records for the Cloud One account. Records are returned in reverse chronological order.

SecuritycloudOneAPIKey
Request
query Parameters
cursor
string

An encoded value used to retrieve the next set of results for a query, using the next value from the previous response. The set size is determined by the LimitParam, which has a maximum value of 25 records.

Example: cursor=dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo=
limit
integer

The maximum numbers of records to return. This parameter accepts an integer from 1 to 25. Other values will cause the request to be rejected.

Example: limit=25
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

Successful operation

400

Bad Request + specific error message

401

Valid authentication was not provided

403

Not authorized to view usage

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Internal server error

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "usage": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo="
}