API ReferenceCloud Vms

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

Cloud VM returned successfully.
idstringOptional
namestringOptional
statusenumOptional
cpuintegerOptional
ram_mbintegerOptional
disk_gbintegerOptional
os_typestringOptional
os_distrostringOptional
plan_namestring or nullOptional
public_ipstring or nullOptional
private_ipstring or nullOptional
tagslist of stringsOptional
created_atdatetimeOptional
updated_atdatetime or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error