API ReferenceCloud Vms

Get cloud VM metric timeseries

Returns rolled-up VM metric series for a supported time range. Requires scope: vm.read.

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

vm_idstringRequired
Virtual machine ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

rangeenumOptionalDefaults to 1h
Allowed values:

Response

VM metric timeseries returned successfully.
rangeenum
resolutionenum
fromdatetime
todatetime
seriesmap from strings to lists of lists of any

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error