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. 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.

Response

VM metrics returned successfully.
vm_idstring
vm_typeenum
power_statestring
monitoring_statusenum
month_rx_bytesintegerDefaults to 0
month_tx_bytesintegerDefaults to 0
last_collected_atdatetime or nullOptional
cpu_percentdouble or nullOptional
memory_used_bytesinteger or nullOptional
memory_used_percentdouble or nullOptional
storage_used_bytesinteger or nullOptional
storage_total_bytesinteger or nullOptional
storage_used_percentdouble or nullOptional
storage_provisioned_bytesinteger or nullOptional
disk_read_bpsdouble or nullOptional
disk_write_bpsdouble or nullOptional
disk_read_iopsdouble or nullOptional
disk_write_iopsdouble or nullOptional
net_rx_bpsdouble or nullOptional
net_tx_bpsdouble or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error