> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # List cluster addresses > Lists the workspace address, preview URLs and custom domains belonging to this cluster, including domains targeting the cluster itself. Ordered by creation time and ID. Cursor-paginated. ## OpenAPI ````yaml /openapi-public.json get /clusters/{id}/addresses openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /clusters/{id}/addresses: get: tags: - Clusters summary: List cluster addresses description: >- Lists the workspace address, preview URLs and custom domains belonging to this cluster, including domains targeting the cluster itself. Ordered by creation time and ID. Cursor-paginated. operationId: clusters.listAddresses parameters: - name: id in: path schema: type: string minLength: 1 maxLength: 54 required: true - name: akua-context in: header schema: type: string minLength: 1 maxLength: 53 description: >- 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. examples: - ws_j572abc123def456 required: false - name: cursor in: query schema: type: string required: false - name: limit in: query schema: type: integer minimum: 1 maximum: 100 required: false responses: '200': description: Cluster addresses page content: application/json: schema: $ref: '#/components/schemas/ClusterAddressList' '400': description: The request is malformed. content: application/json: schema: $ref: '#/components/schemas/ApiBadRequest' '401': description: Missing, invalid or expired credential. content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorized' '403': description: The credential may not act in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiForbidden' '404': description: The resource was not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiNotFound' '409': description: >- The request conflicts with existing resource state or immutable intent. | The resource changed since the etag the client sent; the current etag is in the metadata. | The idempotency key was already used for a different request. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ApiConflict' - $ref: '#/components/schemas/ApiPreconditionFailed' - $ref: '#/components/schemas/ApiIdempotencyConflict' '410': description: The resource is permanently unavailable. content: application/json: schema: $ref: '#/components/schemas/ApiGone' '422': description: The request is well-formed but cannot be processed. content: application/json: schema: $ref: '#/components/schemas/ApiUnprocessable' '429': description: The caller is over its per-minute budget. content: application/json: schema: $ref: '#/components/schemas/ApiTooManyRequests' '500': description: The server failed to handle the request. content: application/json: schema: $ref: '#/components/schemas/ApiInternalServerError' '502': description: An upstream provider failed. content: application/json: schema: $ref: '#/components/schemas/ApiExternalServiceError' '503': description: The service is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/ApiServiceUnavailable' '504': description: An upstream provider did not answer in time. content: application/json: schema: $ref: '#/components/schemas/ApiGatewayTimeout' security: - BearerAuth: [] components: schemas: ClusterAddressList: type: object properties: data: type: array items: $ref: '#/components/schemas/ClusterAddress' has_more: type: boolean next_cursor: anyOf: - type: string - type: 'null' required: - data - has_more - next_cursor additionalProperties: false ApiBadRequest: type: object properties: _tag: type: string enum: - Validation success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiUnauthorized: type: object properties: _tag: type: string enum: - Unauthorized success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiForbidden: type: object properties: _tag: type: string enum: - Forbidden success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiNotFound: type: object properties: _tag: type: string enum: - NotFound success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiConflict: type: object properties: _tag: type: string enum: - Conflict success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiPreconditionFailed: type: object properties: _tag: type: string enum: - PreconditionFailed success: type: boolean enum: - false errors: type: array prefixItems: - type: object properties: code: type: number enum: - 7006 message: type: string metadata: type: object properties: current_etag: type: string required: - current_etag allOf: - type: object additionalProperties: type: string required: - code - message - metadata additionalProperties: false maxItems: 1 minItems: 1 result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiIdempotencyConflict: type: object properties: _tag: type: string enum: - IdempotencyConflict success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiGone: type: object properties: _tag: type: string enum: - Gone success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiUnprocessable: type: object properties: _tag: type: string enum: - Unprocessable success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiTooManyRequests: type: object properties: _tag: type: string enum: - TooManyRequests success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiInternalServerError: type: object properties: _tag: type: string enum: - InternalServerError success: type: boolean enum: - false errors: type: array prefixItems: - type: object properties: code: type: number enum: - 7009 message: type: string enum: - Internal server error required: - code - message additionalProperties: false maxItems: 1 minItems: 1 result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiExternalServiceError: type: object properties: _tag: type: string enum: - ExternalServiceError success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiServiceUnavailable: type: object properties: _tag: type: string enum: - ServiceUnavailable success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiGatewayTimeout: type: object properties: _tag: type: string enum: - GatewayTimeout success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ClusterAddress: oneOf: - type: object properties: kind: type: string enum: - workspace address: type: object properties: id: type: string minLength: 1 maxLength: 54 workspace_id: type: string minLength: 1 maxLength: 53 name: type: string minLength: 1 maxLength: 63 fqdn: type: string minLength: 1 maxLength: 253 status: type: string enum: - active - propagating - reserved name_changed_at: anyOf: - type: integer minimum: 0 - type: 'null' description: Unix timestamp (seconds) created_at: type: integer description: Unix timestamp (seconds) minimum: 0 updated_at: type: integer description: Unix timestamp (seconds) minimum: 0 etag: type: string required: - id - workspace_id - name - fqdn - status - name_changed_at - created_at - updated_at - etag additionalProperties: false required: - kind - address additionalProperties: false - type: object properties: kind: type: string enum: - preview address: $ref: '#/components/schemas/InstallDomainSettingsPreviewHostname' required: - kind - address additionalProperties: false - type: object properties: kind: type: string enum: - customDomain address: $ref: '#/components/schemas/InstallDomainSettingsCustomDomain' required: - kind - address additionalProperties: false ApiErrorEntry: type: object properties: code: type: integer description: Machine-readable error code examples: - 7002 message: type: string description: Human-readable error message examples: - Resource not found path: type: array items: type: string description: Field path that caused the error, when applicable examples: - - body - name metadata: type: object additionalProperties: type: string required: - code - message additionalProperties: false InstallDomainSettingsPreviewHostname: type: object properties: id: type: string minLength: 1 maxLength: 54 workspace_id: type: string minLength: 1 maxLength: 53 install_id: type: string minLength: 1 maxLength: 55 hostname: type: string minLength: 1 maxLength: 253 protocol: type: string enum: - http - websocket - grpc description: Transport class for route forwarding. routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher description: Whether traffic uses the dispatcher Worker or bypasses it. binding_kind: type: string enum: - pinned - floating track: anyOf: - type: string minLength: 1 maxLength: 100 - type: 'null' binding: oneOf: - type: object properties: kind: type: string enum: - pinned render_id: type: string minLength: 1 maxLength: 54 required: - kind - render_id additionalProperties: false - type: object properties: kind: type: string enum: - floating track: type: string minLength: 1 maxLength: 100 render_id: type: string minLength: 1 maxLength: 54 required: - kind - track - render_id additionalProperties: false status: type: string enum: - provisioning - active - evicted - releasing last_seen_at: anyOf: - type: integer minimum: 0 - type: 'null' description: Unix timestamp (seconds) observed_url: anyOf: - type: string - type: 'null' error: anyOf: - type: string - type: 'null' created_at: type: integer description: Unix timestamp (seconds) minimum: 0 updated_at: type: integer description: Unix timestamp (seconds) minimum: 0 etag: type: string required: - id - workspace_id - install_id - hostname - protocol - routing_mode - binding_kind - track - binding - status - last_seen_at - observed_url - error - created_at - updated_at - etag additionalProperties: false InstallDomainSettingsCustomDomain: type: object properties: id: type: string minLength: 1 maxLength: 54 workspace_id: type: string minLength: 1 maxLength: 53 hostname: type: string minLength: 1 maxLength: 253 target: oneOf: - type: object properties: kind: type: string enum: - install install_id: type: string minLength: 1 maxLength: 55 required: - kind - install_id additionalProperties: false - type: object properties: kind: type: string enum: - cluster cluster_id: type: string minLength: 1 maxLength: 54 required: - kind - cluster_id additionalProperties: false - type: object properties: kind: type: string enum: - external endpoint: type: string format: uri mtls_secret_id: type: string minLength: 1 maxLength: 54 required: - kind - endpoint additionalProperties: false protocol: type: string enum: - http - websocket - grpc description: Transport class for route forwarding. routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher description: Whether traffic uses the dispatcher Worker or bypasses it. target_kind: type: string enum: - install - cluster - external cloudflare_custom_hostname_id: anyOf: - type: string - type: 'null' ssl: type: object properties: status: type: string enum: - pending_validation - active - failed validation_records: type: array items: type: object additionalProperties: type: string required: - status additionalProperties: false status: type: string enum: - provisioning - active - failed - releasing error: anyOf: - type: string - type: 'null' created_at: type: integer description: Unix timestamp (seconds) minimum: 0 updated_at: type: integer description: Unix timestamp (seconds) minimum: 0 etag: type: string required: - id - workspace_id - hostname - target - protocol - routing_mode - target_kind - cloudflare_custom_hostname_id - ssl - status - error - created_at - updated_at - etag additionalProperties: false securitySchemes: BearerAuth: description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.