Expose a port
Gives a port of the sandbox its own HTTPS hostname under akua.run, with a random token in the name. HTTP, WebSockets and server-sent events pass through; the URL answers while the sandbox is ACTIVE. One preview per port; exposing an exposed port answers 409. Requires previews.
Authorizations
workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens
Headers
Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.
1 - 53"ws_j572abc123def456"
Path Parameters
Sandbox id (sbx_...).
^sbx_[A-Za-z0-9]{1,64}$"sbx_j572abc123def456"
Body
The port a service in the sandbox listens on.
1 <= x <= 655353000
link (the default): anyone with the URL can open it; the random token in the hostname is the only gate. private: the same hostname, but it needs Akua sign-in and the previews permission on the sandbox.
link, private Readable part of the hostname. Defaults to preview.
^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"checkout"
Response
Port exposed
Sandbox id (sbx_...).
^sbx_[A-Za-z0-9]{1,64}$"sbx_j572abc123def456"
The port a service in the sandbox listens on.
1 <= x <= 655353000
link (the default): anyone with the URL can open it; the random token in the hostname is the only gate. private: the same hostname, but it needs Akua sign-in and the previews permission on the sandbox.
link, private A host of its own under akua.run (<port>-<name>-<token>.akua.run), never shared with the dashboard or another preview.
"3000-checkout-k3x9q2m7a1b8c4d6.akua.run"
"https://3000-checkout-k3x9q2m7a1b8c4d6.akua.run/"
True once the hostname answers. Until preview routing is live everywhere, a new preview is recorded but its URL does not answer yet.
Exposure time (Unix seconds).
x >= 0