Skip to main content
GET
Get preview hostname

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

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.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

id
string
required

Install ID

Required string length: 1 - 55
preview_hostname_id
string
required

Preview hostname ID

Required string length: 1 - 54

Response

Preview hostname

id
string
required
Required string length: 1 - 54
workspace_id
string
required
Required string length: 1 - 53
install_id
string
required
Required string length: 1 - 55
hostname
string
required
Required string length: 1 - 253
protocol
enum<string>
required

Transport class for route forwarding.

Available options:
http,
websocket,
grpc
routing_mode
enum<string>
required

Whether traffic uses the dispatcher Worker or bypasses it.

Available options:
through_dispatcher,
bypass_dispatcher
binding
object
required
status
enum<string>
required

Current preview hostname lifecycle state.

Available options:
provisioning,
active,
evicted,
releasing
last_seen_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required