Skip to main content
PATCH
/
v2
/
sandboxes
/
templates
/
{name}
Update a SandboxTemplate
curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/templates/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "name": "<string>",
  "image": "<string>",
  "resources": {
    "cpu": "500m",
    "memory": "512Mi",
    "storage": "1Gi"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "volume_mounts": [
    {
      "volume_name": "<string>",
      "mount_path": "<string>"
    }
  ],
  "proxy_config": {
    "rules": [
      {
        "name": "<string>",
        "match_hosts": [
          "<string>"
        ],
        "inject_headers": {},
        "match_paths": [
          "<string>"
        ],
        "enabled": true
      }
    ],
    "no_proxy": [
      "<string>"
    ]
  },
  "registry_name": "<string>",
  "registry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

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.

​
registry_name
string | null

Name of the associated private container registry, if any

​
registry_id
string<uuid> | null

ID of the associated private container registry, if any

​
created_at
string | null
​
updated_at
string | null