Skip to main content
PATCH
Update sandbox template

Authorizations

Authorization
string
header
default:Bearer {API_ACCESS_TOKEN}
required

CoreWeave API access token sent as a bearer token.

Path Parameters

sandboxTemplateId
string
required

Identifies the template to update (UUID).

Query Parameters

updateMask
string<field-mask>

Comma-separated JSON paths relative to the sandbox template: displayName, spec, and attachments. Omission updates only populated mutable fields. To replace all mutable fields in JSON, select all three paths. Other paths return INVALID_ARGUMENT. The wildcard * is supported only over binary protobuf (gRPC or Connect protobuf), not JSON Connect or the REST updateMask query value.

Body

application/json

SandboxTemplate is an organization-scoped partial workload template. PartialSandboxSpec / PartialContainer are defined in sandbox.proto.

displayName
string
required

Human-readable name, unique among active (non-deleted) templates in the tenant organization. Trimmed; 1–128 Unicode characters; must not be empty. Prefer names that are not UUID-shaped so they do not collide with id-first Get resolution.

spec
object

Partial workload specification. May omit fields that CreateSandboxFromTemplate supplies via overrides (for example containers). Must not carry policy selectors. Server-enforced size ceiling: 1 MiB.

attachments
object

Optional admin runtime attachments applied when creating a sandbox from this template. Same opaque fragment shape as Policy.base (for example, a PodSpec fragment on a Kubernetes runner). Writable by sandbox_admin only. When set, CreateSandboxFromTemplate requires SANDBOX_MODE_CKS (serverless is rejected; unset mode is treated as CKS). Not part of SandboxSpec; CreateSandbox and create overrides cannot supply or change them.

Response

OK

SandboxTemplate is an organization-scoped partial workload template. PartialSandboxSpec / PartialContainer are defined in sandbox.proto.

displayName
string
required

Human-readable name, unique among active (non-deleted) templates in the tenant organization. Trimmed; 1–128 Unicode characters; must not be empty. Prefer names that are not UUID-shaped so they do not collide with id-first Get resolution.

sandboxTemplateId
string
read-only

Server-assigned unique identifier.

spec
object

Partial workload specification. May omit fields that CreateSandboxFromTemplate supplies via overrides (for example containers). Must not carry policy selectors. Server-enforced size ceiling: 1 MiB.

revision
string
read-only

Monotonic revision; incremented on each successful update. CreateSandboxFromTemplate records the selected revision on the sandbox as source_template_revision.

createTime
string<date-time>
read-only
updateTime
string<date-time>
read-only
deleteTime
string<date-time>
read-only

Set when soft-deleted; unset for active templates.

createUserId
string
read-only

User id of the creator.

deleted
boolean
read-only

True when delete_time is set. Convenience for admin filtering.

attachments
object

Optional admin runtime attachments applied when creating a sandbox from this template. Same opaque fragment shape as Policy.base (for example, a PodSpec fragment on a Kubernetes runner). Writable by sandbox_admin only. When set, CreateSandboxFromTemplate requires SANDBOX_MODE_CKS (serverless is rejected; unset mode is treated as CKS). Not part of SandboxSpec; CreateSandbox and create overrides cannot supply or change them.

requiresCks
boolean
read-only

True when attachments are set. Indicates CreateSandboxFromTemplate for this template requires CKS placement.