POST /v1/sandboxes/{id}/expose

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

port*integer

Range1 <= value <= 65535

public?boolean

http: serve without a preview token. tcp: always true; false is refused.

Defaultfalse

ttl_seconds?integer

http private exposures: token lifetime (default 1 day).

Range1 <= value <= 31536000

protocol?string

http: a preview URL routed by Host (HTTP and WebSocket). tcp: raw TCP (game servers, databases, SSH) on a dedicated public port of the region's control plane — connect to host:public_port. A tcp exposure is always public.

Default"http"

Value in

"http"
"tcp"

proxy_protocol?boolean

tcp only: the guest receives a HAProxy PROXY v1 line with the client address before the first byte, so it sees the real player IP instead of the host (Paper proxies.proxy-protocol, Velocity haproxy-protocol). Only enable it for a server that expects the line.

direct?boolean

tcp only: also accept connections on the same public_port of the host that runs the sandbox, returned as direct_url. One hop and no control plane in the byte path, for latency-sensitive clients such as games. The region address (host:public_port) keeps working and stays stable; the direct address follows the host and changes if the sandbox moves, so re-read it after a migration.

Response Body

`application/json`

curl -X POST "https://example.com/v1/sandboxes/string/expose" \  -H "Content-Type: application/json" \  -d '{    "port": 1  }'

{  "port": 0,  "url": "string",  "token": "string",  "public": true,  "protocol": "http",  "host": "string",  "public_port": 0,  "proxy_protocol": true,  "direct": true,  "direct_host": "string",  "direct_url": "string"}

Empty

Authorization

Path Parameters

Request Body

Response Body

200application/json

401

`application/json`