Skip to main content
PATCH
/
sandboxes
/
{sandbox_id}
Partially update a running sandbox
curl --request PATCH \
  --url https://api-staging.superserve.ai/sandboxes/{sandbox_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metadata": {
    "env": "prod",
    "owner": "agent-7"
  }
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.superserve.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
sandbox_id
string<uuid>
required

The unique identifier of the sandbox.

Body

application/json

Partial update body for PATCH /sandboxes/{sandbox_id}. Each top-level field is optional; only fields that are present are applied. Omitted fields are left unchanged. Nested objects are full replacements when present — to clear a list, send it as an empty array.

At least one top-level field must be set, otherwise the request is rejected with 400. Unknown fields are also rejected with 400.

​
network
object

Replace the sandbox's egress rules. The sandbox must be in the active state. The provided allow_out and deny_out lists fully replace whatever was previously configured.

​
metadata
object

Replace the sandbox's metadata tags. Fully replaces the existing metadata — omitted keys are removed. Can be patched regardless of sandbox state. Same validation limits as on create (64 keys, 256-byte keys, 2 KB values, 16 KB total).

Response

Patch applied