API ReferenceCloud Vms

Get cloud VM metrics

Returns current resource-usage metrics for a cloud VM. Requires scope: vm.read.

Authentication

AuthorizationBearer

IBEE platform API token, for example: ibee_live_xxx.

Path parameters

vm_idstringRequired
Virtual machine ID.

Query parameters

workspace_idstringRequired
The workspace ID to scope this request to.

Response

VM metrics returned successfully.
cpu_usage_percentdouble
memory_usage_percentdouble
disk_read_bytesinteger
disk_write_bytesinteger
network_in_bytesinteger
network_out_bytesinteger
collected_atdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error