Get a cloud VM
Returns a single 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_id
Virtual machine ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Response
Cloud VM returned successfully.
id
Unique VM ID.
name
Display name of the VM.
status
Lifecycle status of the VM.
pending: create accepted, not started yet.creating,provisioning: compute, disk and network resources are being allocated.configuring: the guest is being configured (keys, network, cloud-init).running: powered on.starting: a start is in progress.stopping: a stop is in progress.stopped: powered off.rebooting: a reboot is in progress.resizing,resizing_plan,resizing_disk: a CPU/memory or root-disk change is being applied.attaching_volume,detaching_volume: a block volume is being attached or detached.deleting: a delete is in progress.deleted: the VM no longer exists.error: the last operation failed; see the operation or events for detail.
cpu
vCPUs.
ram_mb
Memory in MB.
disk_gb
Root disk size in GB.
os_type
OS family: linux or windows.
os_distro
OS distribution, for example ubuntu.
plan_name
Name of the compute plan the VM runs on.
public_ip
Public IPv4 address; null when the VM has none.
private_ip
Private IPv4 address; null when none is assigned.
created_at
When the VM was created (ISO 8601).
updated_at
When the VM record was last changed (ISO 8601).
Errors
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
