RErender
Sandboxes

Create sandbox snapshot

Changed on

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.

post/sandboxes/{sandboxId}/snapshots

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Parameters

#/paths/~1sandboxes~1{sandboxId}/get/parameters/0 (unresolved $ref)

Request body

kindKind (unresolved $ref)
namestring

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.

expiresAtstring 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.

Response

Capture accepted. Returns the snapshot in creating.

idSchema required(unresolved $ref)
sandboxGroupIdSchema required(unresolved $ref)
sourceSandboxIdSchema required(unresolved $ref)
nameName (unresolved $ref)
kind'filesystem' | 'runtime' required

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.

statusItems required(unresolved $ref)
planstring required

Plan of the source sandbox at capture time. See sandboxPlan for known values.

requestedAtstring date-time required
capturedAtstring date-time nullable

When the sandbox was frozen for capture. Null until available.

expiresAtstring date-time required

The time after which the snapshot can no longer be retrieved or restored. Set by Render when the create request did not specify one.

sizeBytesinteger nullable

Null until available.

errorstring nullable

Null unless failed.

Changes