v3

latestOpenAPI 3.0.12026-08-0678153248.4 KB
Sandboxes

Expose a sandbox port

post/api/sandbox/{id}/expose

Path parameters

idstring uuid required

Sandbox ID

Request body

portinteger required

Port inside the sandbox to expose.

authboolean

Require authentication for requests to the exposed URL.

Response

Port exposed

portinteger required
authboolean required

Whether requests to the exposed URL require authentication.

urlstring required

Public URL that routes to the exposed port.

browserUrlstring

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

browserUrlExpiresAtstring date-time nullable

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