Skip to main content
POST
/
api
/
cluster
{
  "data": {
    "id": "<string>",
    "vm_count": 1,
    "vms": [
      {
        "children": [
          "<string>"
        ],
        "cluster_id": "<string>",
        "id": "<string>",
        "ip_address": "<string>",
        "network_info": {
          "guest_ip": "<string>",
          "guest_mac": "<string>",
          "ssh_port": 1,
          "tap0_ip": "<string>",
          "tap0_name": "<string>",
          "vm_namespace": "<string>"
        },
        "state": "Not started",
        "parent_id": "<string>"
      }
    ],
    "root_vm_id": "<string>"
  },
  "duration_ns": 1,
  "operation_id": "<string>",
  "time_start": 1
}

Authorizations

​
Authorization
string
header
required

Bearer token in Authorization header

Body

application/json
​
fs_size_cluster_mib
integer<int64> | null

The amount of total space to allocate to the cluster

Required range: x >= 0
​
fs_size_vm_mib
integer<int64> | null

The size of the VM filesystem (if smaller than the base image + overhead, will cause an error)

Required range: x >= 0
​
kernel_name
string | null
​
mem_size_mib
integer<int64> | null
Required range: x >= 0
​
rootfs_name
string | null
​
vcpu_count
integer<int64> | null
Required range: x >= 0

Response

Cluster created successfully

​
data
object
required
​
duration_ns
integer
required
Required range: x >= 0
​
operation_id
string
required
​
time_start
integer<int64>
required

Unix epoch time (secs)

Required range: x >= 0