Create sandbox snapshot

Capture a snapshot of a running sandbox. Returns HTTP 202 with the snapshot in creating status. Retrieve the snapshot until its status is available or failed. The sandbox continues running, with a brief pause when capturing a runtime snapshot.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^sbx-[0-9a-v]{25}$

The ID of the sandbox.

Query Params
string

The ID of the workspace the sandbox belongs to. If provided, it must match the sandbox's workspace. If omitted, Render determines the workspace from the sandbox ID.

Body Params

The settings for the sandbox snapshot to capture.

string
enum
Defaults to runtime

The state to capture in the snapshot. Defaults to runtime.

Allowed:
string
length between 1 and 64

A case-sensitive name for snapshots in a sandbox group, up to 64 characters. Must not start with snp-. Multiple snapshots can share a name. When creating a sandbox by snapshot name, Render uses the most recently created snapshot with that name that is available and unexpired.

integer
≥ 0

The snapshot's lifetime after its last use, in seconds. Creating a sandbox from this snapshot resets its remaining lifetime to this duration. Use 0 to keep the snapshot until you delete it. Defaults to Render's snapshot lifetime. Cannot be combined with expiresAt.

date-time
deprecated

The expiration timestamp, in ISO 8601 format. Deprecated; use ttlSeconds instead. Must be in the future. Render sets the snapshot lifetime to the duration between the request and this timestamp.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json