Skip to main content
POST
/
vm
/
{vm_id}
/
commit
cURL
curl --request POST \
  --url https://api.example.com/vm/{vm_id}/commit \
  --header 'Authorization: Bearer <token>'
{
  "commit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

vm_id
string
required

VM ID to commit

Query Parameters

keep_paused
boolean

If true, keep VM paused after commit

skip_wait_boot
boolean

If true, return an error immediately if the VM is still booting. Default: false

Response

VM committed successfully

The response body for POST /api/vm/{vm_id}/commit

commit_id
string<uuid>
required

The UUID of the newly-created commit