API Reference

Create sandbox snapshot

post
https://api.render.com/v1/sandboxes//snapshots

Capture a snapshot of a running sandbox. Returns 202 with the snapshot in
creating. Poll until it is available or failed. The sandbox keeps
running; a runtime capture pauses it briefly.

400 with code: invalid_snapshot_name if name is malformed. 409 with
code: sandbox_not_running if the sandbox is not running, or
code: sandbox_group_suspended if the sandbox group is suspended.

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. Optional: the workspace is
determined from the sandbox ID, and this parameter is ignored when supplied.

Body Params
string
enum
Defaults to runtime

filesystem captures the writable filesystem and restores onto any plan.
runtime also captures memory and CPU state and restores only onto the
plan of the source sandbox.

Allowed:
string
length between 1 and 64

Case sensitive. Scoped to the sandbox group. Must not start with snp-
so clients can tell a name from a snapshot ID. Several snapshots may
share a name; the most recently available one is the one the name
resolves to.

date-time

The time after which the snapshot can no longer be retrieved or restored.
Must be in the future. Omit to use Render's default snapshot lifetime.

Responses

Updated about 9 hours ago

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

Updated about 9 hours ago