Skip to main content
POST
Expose a sandbox port

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Sandbox ID

Body

application/json
port
integer
required

Port inside the sandbox to expose.

Required range: 1 <= x <= 65535
auth
boolean
default:false

Require authentication for requests to the exposed URL.

Response

200 - application/json

Port exposed

port
integer
required
Required range: 1 <= x <= 65535
auth
boolean
required

Whether requests to the exposed URL require authentication.

url
string
required

Public URL that routes to the exposed port.

browserUrl
string

URL that bootstraps browser access. For authenticated ports this includes a short-lived grant token.

browserUrlExpiresAt
string<date-time> | null

Expiry of the browser bootstrap grant, if auth is enabled.