Skip to main content
POST
Publish or update a preview port

Authorizations

X-API-Key
string
header
required

Path Parameters

sandbox_id
string
required

The unique identifier of the sandbox. Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json
port
integer
required

Port to publish. Port 49983 is reserved for Superserve's sandbox service.

Required range: 1024 <= x <= 65535
access
enum<string>

Explicit per-port mode. When omitted for a new row, inherits the sandbox preview_access default. When omitted for an existing row, preserves that row's current mode.

Available options:
public,
private

Response

Published port

port
integer
required

Published port. Port 49983 is reserved for Superserve's sandbox service.

Required range: 1024 <= x <= 65535
access
enum<string>
required

Independent access mode for this published port. Requests to a private port must present its preview token using the header named by the token-mint response's header field, the signed-link query parameter named by query_param, or the cookie established by a successful signed-link GET bootstrap.

Available options:
public,
private
token_version
integer<int64>
required

Durable generation used to scope credentials for this port. Rotation, access changes, and unpublish/re-publish advance it.

Required range: x >= 1