API ReferenceCloud Vms

Create a cloud VM

Creates a cloud VM. Returns an operation you can poll for status. Requires scope: vm.write.

Authentication

AuthorizationBearer

IBEE platform API token, for example: ibee_live_xxx.

Headers

X-Idempotency-KeystringRequired
Unique key used to safely retry write operations.

Query parameters

workspace_idstringRequired
The workspace ID to scope this request to.

Request

This endpoint expects an object.
namestringRequired>=1 character
Display name for the virtual machine.
os_distrostringRequired

Operating system distribution (e.g. ubuntu, centos, debian, rocky, windows).

os_typeenumRequired
Operating system family.
cpuintegerRequired>=1
Number of vCPUs.
ram_mbintegerRequired>=512
RAM in megabytes.
template_idstring or nullOptional
OS template or image ID.
disk_gbinteger or nullOptional>=10
Root disk size in gigabytes.
plan_idstring or nullOptional

Pre-configured plan ID. Overrides cpu, ram_mb, and disk_gb when set.

ssh_key_idslist of stringsOptional
SSH key IDs to inject into the VM.
tagslist of stringsOptional
Arbitrary tags for filtering and organization.

Response

VM creation accepted.
operation_idstring
vm_idstring
statusstring
submitted_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error