Get cloud VM monthly bandwidth

GET

/compute/cloud-vms/:vm_id/metrics/bandwidth

Returns received and transmitted byte totals for a calendar month. 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.

monthstringRequiredformat: "^[0-9]{4}-(0[1-9]|1[0-2])$"

Response

VM bandwidth summary returned successfully.

monthstringformat: "^[0-9]{4}-(0[1-9]|1[0-2])$"

rx_bytesintegerDefaults to 0

tx_bytesintegerDefaults to 0

last_updated_atdatetime or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

$	curl -G https://api.ibee.ai/v1/compute/cloud-vms/vm_id/metrics/bandwidth \
>	-H "Authorization: Bearer <token>" \
>	-d workspace_id=710995 \
>	-d month=2026-08

1	{
2	"month": "string",
3	"rx_bytes": 0,
4	"tx_bytes": 0,
5	"last_updated_at": "2024-01-15T09:30:00Z"
6	}