Skip to main content
GET
List custom domains

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

Query Parameters

cursor
string

Pagination cursor from a previous response's next_cursor.

limit
integer
default:50

Items per page (1-100, default 50)

Required range: 1 <= x <= 100
Example:

50

target_kind
enum<string>
Available options:
install,
cluster,
external
state
enum<string>
Available options:
provisioning,
active,
failed,
releasing

Response

Custom domain list

data
object[]
required
has_more
boolean
required

True if more items exist after this page.

next_cursor
string | null
required

Opaque cursor for the next page, or null if no more pages.