Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vm_or_commit_id
string
required

Parent VM or commit ID

Query Parameters

keep_paused
boolean

If true, keep VM paused after commit. Only applicable when branching a VM ID.

skip_wait_boot
boolean

If true, immediately return an error if VM is booting instead of waiting. Only applicable when branching a VM ID.

count
integer<int32>

Number of VMs to branch (optional; default 1)

Required range: x >= 0

Response

Branch VM created successfully

vms
object[]
required