> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cnap.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# List clusters in workspace

> Lists all clusters in the workspace specified by the X-Workspace-Id header.



## OpenAPI

````yaml /openapi.json get /v1/clusters
openapi: 3.1.0
info:
  title: CNAP API
  version: 1.0.0
  description: >-
    Public API for managing CNAP workspaces, clusters, templates, products, and
    deployments.


    Authenticate with a Personal Access Token via the `Authorization: Bearer
    cnap_pat_...` header.


    Workspace-scoped endpoints require the `X-Workspace-Id` header.
servers:
  - url: https://api.cnap.tech
    description: Production
security: []
paths:
  /v1/clusters:
    get:
      tags:
        - Clusters
      summary: List clusters in workspace
      description: >-
        Lists all clusters in the workspace specified by the X-Workspace-Id
        header.
      parameters:
        - schema:
            type: string
            description: Pagination cursor from previous response
          required: false
          description: Pagination cursor from previous response
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Items per page (1-100)
            example: 50
          required: false
          description: Items per page (1-100)
          name: limit
          in: query
      responses:
        '200':
          description: List of clusters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing or invalid workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    ClusterList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: not_found
            message:
              type: string
              example: Resource not found
            param:
              type: string
              description: The request field that caused the error
              example: name
            suggestion:
              type: string
              example: Run `cnap clusters list` to see available clusters
            details: {}
          required:
            - code
            - message
      required:
        - error
    Cluster:
      type: object
      properties:
        id:
          type: string
          example: j572abc123def456
        name:
          type: string
          example: production
        workspace_id:
          type: string
          example: j572abc123def456
        region_id:
          type: string
          example: j572abc123def456
        kaas:
          $ref: '#/components/schemas/KaasInfo'
        created_at:
          type: number
          description: Unix timestamp (seconds)
      required:
        - id
        - name
        - workspace_id
        - region_id
        - kaas
        - created_at
    Pagination:
      type: object
      properties:
        cursor:
          type:
            - string
            - 'null'
          description: Cursor for next page, null if no more
        has_more:
          type: boolean
      required:
        - cursor
        - has_more
    KaasInfo:
      type:
        - object
        - 'null'
      properties:
        version:
          type: string
          example: v1.30
          description: Kubernetes version
        status:
          type: string
          enum:
            - PROVISIONING
            - RUNNING
            - RECONCILING
            - SUSPENDING
            - SUSPENDED
            - RESUMING
            - DELETING
            - ERROR
            - DEGRADED
          example: RUNNING
          description: Current lifecycle status of the KaaS cluster
        status_message:
          type:
            - string
            - 'null'
          example: null
          description: Human-readable status details
      required:
        - version
        - status
        - status_message
      description: Present if cluster is KaaS-managed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at
        https://cnap.tech/account/tokens

````