List custom domains

Lists custom domains belonging to a workspace.

GET /workspaces/{id}/custom_domains

List custom domains

cURL

curl --request GET \
  --url https://api.akua.dev/v1/workspaces/{id}/custom_domains \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "hostname": "<string>",
      "target": {
        "install_id": "<string>"
      },
      "ssl": {
        "validation_records": [
          {}
        ]
      },
      "created_at": 1,
      "updated_at": 1,
      "etag": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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

200

application/json

Custom domain list

data · object[] · required

Show child attributes

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.