Skip to main content
POST
Take a snapshot

Authorizations

Authorization
string
header
required

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

Path Parameters

vm_id
string<uuid>
required

VM UUID

Body

application/json
name
string
required

Snapshot name.

Example:

"vm-snapshot-name"

team_id
string<uuid>

Team ID. Default team will be used if not provided.

Example:

"96616865-475e-4191-aba5-f89f0a4b71fe"

desc
string

Snapshot description.

Example:

"snapshot @ 20/09/2025"

Response

Snapshot started

snapshot_id
string<uuid>
Example:

"c1d45377-b2a9-4407-ab8d-6909c34dfaac"