Skip to main content
PATCH
Update a SandboxTemplate

Path Parameters

name
string
required

Template name

Body

application/json

Request model for updating a SandboxTemplate.

Currently only the display name can be updated.

name
string | null

New display name for the template (max 63 chars, DNS-1035 format). Must be unique within the organization.

Response

Successful Response

Response model for a SandboxTemplate.

name
string
required
image
string
required
resources
ResourceSpec · object
required

Resource specification for a sandbox.

id
string<uuid> | null

Unique template identifier

volume_mounts
VolumeMountSpec · object

Specification for mounting a volume in a sandbox template.

proxy_config
ProxyConfig · object

Proxy configuration for a sandbox template.

When proxy_config is set, a smithbox-proxy sidecar will be deployed alongside the sandbox container to intercept HTTPS traffic and inject headers based on the configured rules.

created_at
string | null
updated_at
string | null