> ## 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 capabilities

> The platform-owned components of the Cluster (tunnel connector, private ingress gateway, storage, metrics) with the release each runs.



## OpenAPI

````yaml /openapi-public.json get /clusters/{id}/capabilities
openapi: 3.1.0
info:
  title: Akua API
  version: 1.0.0
  description: >-
    Manage installs and their asynchronous operations. Authenticate with a
    session bearer token and select a Workspace using Akua-Context.
  contact:
    name: Akua API support
    email: support@akua.dev
    url: https://docs.akua.dev/
servers:
  - url: https://api.akua.dev/v1
security: []
tags:
  - name: operations
  - name: installs
  - name: Organizations
  - name: Billing accounts
  - name: workspaces
  - name: regions
  - name: Dashboard Overview
  - name: products
  - name: offers
  - name: Order Drafts
  - name: packages
  - name: Auth
  - name: API Tokens
  - name: Quota adjustments
  - name: Workspace services
  - name: Vault connections
  - name: clusters
  - name: Node pools
  - name: Nodes
  - name: machines
  - name: Sandboxes
  - name: OpenCode Servers
  - name: vaults
  - name: vaultSecrets
paths:
  /clusters/{id}/capabilities:
    get:
      tags:
        - clusters
      summary: List capabilities
      description: >-
        The platform-owned components of the Cluster (tunnel connector, private
        ingress gateway, storage, metrics) with the release each runs.
      operationId: clusters.listCapabilities
      parameters:
        - name: id
          in: path
          schema:
            type: string
            minLength: 3
            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_j572abc123def4
          required: false
        - name: cursor
          in: query
          schema:
            type: string
            description: Pagination cursor from a previous response's `next_cursor`.
          required: false
        - name: limit
          in: query
          schema:
            type: integer
            description: Items per page (1-100, default 50)
            default: 50
            minimum: 1
            maximum: 100
          required: false
      responses:
        '200':
          description: The Cluster’s capabilities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterAddonList'
        '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:
    ClusterAddonList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClusterAddon'
        has_more:
          type: boolean
          description: True if more items exist after this page.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Opaque cursor for the next page, or null if no more pages.
      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
    ClusterAddon:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/ClusterAddonName'
        cluster_id:
          type: string
          minLength: 3
          maxLength: 54
        kind:
          type: string
          enum:
            - capability
            - addon
          description: >-
            `capability`: platform-owned; you never install or remove it.
            `addon`: installed by you (not offered yet).
        location:
          type: string
          enum:
            - in-cluster
            - control-plane
          description: >-
            Where its Placement is applied from: by the connector inside the
            Cluster, or by the connector beside the hosted control plane.
            Changing it is a delete and a create, never a silent move.
        desired:
          anyOf:
            - $ref: '#/components/schemas/ClusterAddonRevision'
            - type: 'null'
          description: >-
            What the ring wants it to run, recorded when the install is accepted
            and when an update starts; null once the add-on is being deleted.
        applied:
          anyOf:
            - $ref: '#/components/schemas/ClusterAddonRevision'
            - type: 'null'
          description: What runs now.
        last_known_good:
          anyOf:
            - $ref: '#/components/schemas/ClusterAddonRevision'
            - type: 'null'
          description: The last release that reached Current; what a rollback restores.
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/ClusterAddonCondition'
      required:
        - name
        - cluster_id
        - kind
        - location
        - desired
        - applied
        - last_known_good
        - conditions
      additionalProperties: false
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          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
    ClusterAddonName:
      type: string
      enum:
        - tunnel-connector
        - private-ingress-gateway
        - local-path-storage
        - metrics-server
        - cni
        - incluster-api-proxy
        - cluster-connector
      description: >-
        `cni`, `incluster-api-proxy` and `cluster-connector` run on hosted
        Clusters only, applied from beside the control plane.
    ClusterAddonRevision:
      type: object
      properties:
        version:
          type: string
          maxLength: 64
        package_digest:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: >-
            SHA-256 over the component, version and every pinned image digest of
            the release, or its Package digest.
        config_hash:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: >-
            SHA-256 over the render inputs other than the package: Cluster,
            Origin, ring and location.
      required:
        - version
        - package_digest
        - config_hash
      additionalProperties: false
    ClusterAddonCondition:
      type: object
      properties:
        type:
          type: string
          enum:
            - Available
            - Progressing
            - Degraded
        status:
          type: boolean
        reason:
          type: string
          enum:
            - Applied
            - NotApplied
            - Installing
            - Updating
            - WaitingForNodes
            - Deleting
            - Deleted
            - Settled
            - UpdateRolledBack
            - ApplyFailed
            - Unauthorized
            - Healthy
          description: >-
            Fixed reasons per type.

            - `Available`: `Applied`, or `NotApplied`, `Deleting`, `Deleted`.

            - `Progressing`: `Installing`, `Updating` or `Deleting` while a
            change runs, `WaitingForNodes` while an accepted release waits for
            the first Ready node to be health-checked, else `Settled`.

            - `Degraded`: `UpdateRolledBack` (the last update failed its health
            gate and was rolled back), `ApplyFailed` (the install or the
            rollback did not become healthy) or `Unauthorized` (the cluster API
            refuses the credential or the rights of the connector that applies
            it; nothing it applies changes until they are restored), else
            `Healthy`.
        message:
          type: string
          maxLength: 512
        last_transition_at:
          anyOf:
            - type: integer
              minimum: 0
              description: Unix timestamp (seconds)
            - type: 'null'
          description: When the failure or rollback was recorded; null otherwise.
      required:
        - type
        - status
        - reason
        - message
        - last_transition_at
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      description: Bearer token for the authenticated caller.
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.