Skip to main content
POST
Expose a sandbox port on a public HTTPS URL

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json
port
integer
required

Port the service listens on inside the sandbox.

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

Return an ungated URL instead of one that requires the _token query parameter.

localhost
boolean
default:false

Set when the service listens on localhost (127.0.0.1 or ::1) only. The sandbox relays the URL to it. Leave unset for a service bound to 0.0.0.0. Each call sets the value again.

title
string

Display title for the hosted port.

Response

The public HTTPS URL for the port.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"port.hosted"

success
boolean
port
integer
url
string<uri>

Public HTTPS URL. Carries the _token query parameter unless the port is public; redact from logs.

isProtected
boolean
access
enum<string>
Available options:
private,
public
localhost
boolean

The sandbox relays the URL to a service that listens on localhost only.