compute
usage

List all usages

Changed on
get/compute/{connection_id}/usage

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/compute/{connection_id}/usage
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

instance_idstring

The ComputeInstance ID to filter by

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the usage record

created_atstring date-time

When the usage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the usage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

start_atstring date-time

Start of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

End of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

instance_idstring

The instance the usage belongs to, when per-instance

category'GPU' | 'CPU' | 'MEMORY' | 'STORAGE' | 'NETWORK' | 'OTHER'

What was consumed

quantitynumber

Amount consumed, in unit

unit'GPU_HOUR' | 'VCPU_SECOND' | 'GB_SECOND' | 'GB_MONTH' | 'BYTE' | 'SECOND' | 'OTHER'

Unit of quantity

cost_amountnumber

Cost of the usage, when the vendor reports it

currencystring

Currency of cost_amount (ISO 4217)

rawobject

Raw data from integration

Changes