Skip to navigation
API ReferenceSandboxes

Expose a sandbox port as a preview URL

Beta
View as Markdown
An authenticated HTTPS URL that forwards to a TCP port inside the sandbox until it expires or is deleted.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

sandboxIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
portintegerRequired1-65535

A TCP port a process in the sandbox listens on (127.0.0.1).

expiresInSecondsintegerOptional60-900Defaults to 900
How long the preview URL works.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

Created
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
expiresAtdatetime
RFC 3339 timestamp with a UTC offset.
idstring
Unique sandboxConnection identifier generated by BCTRL.
object"sandbox_port"
portinteger1-65535
sandboxIdstring
Unique sandbox identifier generated by BCTRL.
urlstringformat: "uri"

Authenticated preview URL. It carries its credential: share it only with whoever may use the port.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error