List cloud VMs

GET

/compute/cloud-vms

Returns all cloud VMs in the workspace. 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.

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

1	[
2	{
3	"id": "vm_abc123",
4	"name": "web-server-01",
5	"status": "running",
6	"cpu": 2,
7	"ram_mb": 4096,
8	"disk_gb": 80,
9	"os_type": "linux",
10	"os_distro": "ubuntu",
11	"plan_name": "standard-2x4",
12	"public_ip": "103.149.10.42",
13	"private_ip": "10.0.1.15",
14	"tags": [
15	"string"
16	],
17	"created_at": "2024-01-15T09:30:00Z",
18	"updated_at": "2024-01-15T09:30:00Z"
19	}
20	]

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