Skip to main content
POST
Snapshot Machine

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Idempotency-Key
string | null

Repeat a request safely: the same key and body return the original result.

Maximum string length: 120

Path Parameters

machine
string
required

Body

application/json
name
string | null

The name.

Maximum string length: 128

Response

Successful Response

id
string
required

The snapshot id (snp_…): create a machine from it with from_snapshot.

status
string
required

The state (see the enum).

created_at
string | null
required

When it was created (ISO 8601).

next
string
required

What to do next, for agents.