Skip to navigation

Get cloud VM monthly bandwidth

Returns a cloud VM’s received and transmitted byte totals for a calendar month. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VM_ID: Virtual machine ID
curl "https://api.ibee.ai/v1/compute/cloud-vms/$VM_ID/metrics/bandwidth?workspace_id=$WORKSPACE_ID&month=2026-08" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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])$"

Calendar month to report, as YYYY-MM (for example 2026-08).

Response

VM bandwidth summary returned successfully.
monthstringformat: "^[0-9]{4}-(0[1-9]|1[0-2])$"

Month in YYYY-MM form.

rx_bytesintegerDefaults to 0
Bytes received in the month.
tx_bytesintegerDefaults to 0
Bytes transmitted in the month.
last_updated_atdatetime or nullOptional

When the counters were last updated (ISO 8601).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error