Skip to main content
PUT
Update Sandbox Egress Policy Endpoint

Rate Limit

120 requests per 60 seconds per IP and token per sandbox.

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

Body

application/json

Full replacement of a running VM sandbox's egress policy.

Exactly one of allowlist or denylist must be non-null. An empty allowlist denies all egress; an empty denylist restores allow-all. rules is part of the same complete replacement: omitting it clears the rules.

allowlist
string[] | null
denylist
string[] | null
rules
Rules · object | null

Response

Successful Response

Desired vs applied egress policy state for a VM sandbox.

policy
SandboxEgressPolicyBody · object
required

The desired egress policy: at most one list is non-null.

generation
integer
required

Desired policy generation persisted by the platform.

Required range: x >= 0
applied_generation
integer
required

Generation last reported applied by the sandbox's node, or -1 when no network policy has been successfully applied.

Required range: x >= -1
applied
boolean
required

Whether the node reports the exact desired generation as applied. Never derived from the platform database alone.