Skip to main content
GET
Get custom domain

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Workspace ID

Required string length: 1 - 53
custom_domain_id
string
required

Custom domain ID

Required string length: 1 - 54

Response

Custom domain

id
string
required
Required string length: 1 - 54
workspace_id
string
required
Required string length: 1 - 53
hostname
string
required
Required string length: 1 - 253
target
object
required
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
ssl
object
required
status
enum<string>
required
Available options:
provisioning,
active,
failed,
releasing
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