Create a snapshot
Capture sandbox state and return a platform snapshot ID and user aliases.
Call Create sandbox first and replace sbx_123 with its returned sandboxID.
/sandbox/v1/sandboxes/{sandboxID}/snapshots● SupportedRequest parameters
sandboxIDstring必填path: Sandbox ID.
namestring可选Optional alias. Reusing it within your subject updates the existing snapshot and retains its platform ID.
Returns
201
Errors follow the E2B format — see error codes
Response
HTTP 201
Snapshot created successfully
application/json
| Name | Type | Description |
|---|---|---|
| snapshotID | string | Identifier of the snapshot template including the tag. Uses namespace/alias when a name was provided (e.g. team-slug/my-snapshot:default), otherwise falls back to the raw template ID (e.g. abc123:default). |
| names | array<string> | Full names of the snapshot template including team namespace and tag (e.g. team-slug/my-snapshot:v2) |
The own endpoint adds createdAt (string, ISO 8601 UTC creation time) to the response, or each list row.
Snapshots also include sourceSandboxID (string, public source sandbox ID) and sourceSandboxName (string or null). If the name is unavailable, it is null; display the ID as fallback.
The gateway sets X-Praxis-Face: own-v1; clients need not send it. The /e2b compatibility endpoint strips this header and retains its vendor response shape.
Send {"name":"my-snapshot"} in the JSON body of POST /sandbox/v1/sandboxes/{sandboxID}/snapshots to name a snapshot. The name is persisted and returned in names.