API Reference

Create sandbox

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

Create a sandbox and return its initial state. The sandbox might still be
starting when the response is returned. To use a saved snapshot or custom
image, provide snapshotId, snapshotName, buildId, or buildName.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The sandbox to create, including its compute plan, network policy, and optional source build or snapshot.

string
required

The ID of the workspace the sandbox belongs to.

string
^sbg-[0-9a-v]{20}$

The ID of the sandbox group to create the sandbox in. Defaults to the workspace's default group.

string
length ≤ 64

A label for the sandbox, such as my-agent, up to 64 characters. Names do
not have to be unique; use the sandbox ID to identify a specific sandbox.
Must not start with sbx-.

networkPolicy
object

The outbound traffic policy to apply to the sandbox. Provide type or its
deprecated alias default. If both are provided, they must match.

enum

The compute plan for the sandbox. See sandboxPlan for known values.

The compute plan for the sandbox. The starter, standard, and pro plans are deprecated.

integer

The maximum time the sandbox can run continuously, in seconds. The sandbox
terminates when this time elapses. If the sandbox is suspended and later
resumed, this timeout restarts.

Use 0 to disable the runtime timeout. Positive values must be between 60
and 2592000 (30 days). Defaults to 86400, or to the source sandbox's runtime
timeout when creating a sandbox from a snapshot.

integer
0 to 86400

The number of seconds of inactivity before Render suspends the sandbox.
Use 0 to disable automatic idle suspension. Positive values must be between
300 and 86400. Defaults to 900, or to the source sandbox's idle timeout when
creating a sandbox from a snapshot.

env
object

The environment variables to set when creating the sandbox.

string
^snp-[0-9a-v]{20}$

The ID of the snapshot to create the sandbox from instead of the base image.
The snapshot must be available and belong to the same sandbox group. For
a runtime snapshot, plan must match the snapshot's plan. The new sandbox
inherits the source sandbox's network policy, timeout, and idle timeout.
Provide networkPolicy, timeoutSeconds, or idleTimeoutSeconds to override
these settings.

string
length between 1 and 64

The name of the snapshot to create the sandbox from. Uses the most recently
created snapshot with this name in the sandbox group that is available
and unexpired. Cannot be combined with snapshotId. The same restore
requirements as snapshotId apply.

string
^sbb-[0-9a-v]{20}$

The ID of the build to create the sandbox from instead of the base image.
The build must have succeeded and belong to the same sandbox group. Cannot
be combined with buildName, snapshotId, or snapshotName.

string
length between 1 and 255

The name of the build to create the sandbox from instead of the base image.
Uses the newest successful build with this name in the sandbox group. Cannot
be combined with buildId, snapshotId, or snapshotName.

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