Skip to main content
PATCH
/
sandboxes
/
{sandbox_id}
Update a sandbox
curl --request PATCH \
  --url https://api.tensorlake.ai/sandboxes/{sandbox_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_unauthenticated_access": true,
  "exposed_ports": [
    32768
  ]
}
'
{
  "id": "<string>",
  "namespace": "<string>",
  "image": "<string>",
  "status": "pending",
  "created_at": 123,
  "resources": {
    "cpus": 123,
    "memory_mb": 123,
    "ephemeral_disk_mb": 123
  },
  "timeout_secs": 123,
  "allow_unauthenticated_access": true,
  "pending_reason": "<string>",
  "outcome": "<string>",
  "container_id": "<string>",
  "executor_id": "<string>",
  "sandbox_url": "<string>",
  "pool_id": "<string>",
  "network_policy": {
    "allow_internet_access": true,
    "allow_out": [
      "<string>"
    ],
    "deny_out": [
      "<string>"
    ]
  },
  "exposed_ports": [
    32768
  ],
  "template_id": "<string>"
}
Update public ingress settings for a sandbox. This endpoint controls the sandbox proxy allowlist, including exposed_ports and allow_unauthenticated_access.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
sandbox_id
string
required

The ID of the sandbox.

Body

application/json
​
allow_unauthenticated_access
boolean

Set or clear unauthenticated ingress routing for this sandbox.

​
exposed_ports
integer<int32>[]

Replace the exposed port allowlist. Pass an empty array to clear it and revert to the default management port only.

Required range: 1 <= x <= 65535

Response

Sandbox updated successfully

​
id
string
required
​
namespace
string
required
​
image
string
required
​
status
enum<string>
required
Available options:
pending,
running,
snapshotting,
suspending,
suspended,
terminated
​
created_at
integer<int64>
required

Milliseconds since Unix epoch.

​
resources
object
required
​
timeout_secs
integer<int64>
required
​
allow_unauthenticated_access
boolean
required

Whether sandbox ingress may route requests without auth validation.

​
pending_reason
string | null

Present when status is pending.

​
outcome
string | null

Platform-specific termination outcome string returned for completed sandboxes.

​
container_id
string | null
​
executor_id
string | null
​
sandbox_url
string | null

Public management URL for the sandbox daemon API on port 9501.

​
pool_id
string | null
​
network_policy
object
​
exposed_ports
integer<int32>[] | null

Additional routable ingress ports. When null, only the management port 9501 is routable.

Required range: 1 <= x <= 65535
​
template_id
string | null