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

# List LKS clusters

> Lists every LKS cluster of a project. The response is not paginated; `meta.total` is the number of clusters returned.




## OpenAPI

````yaml https://spec.speakeasy.com/latitude/latitude/latitude-sh-api-with-code-samples get /lks/clusters
openapi: 3.0.1
info:
  title: Latitude.sh API
  version: '2023-06-01'
  description: >-
    The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It
    allows you to perform the same actions as the Latitude.sh dashboard.
servers:
  - url: https://api.latitude.sh
    variables:
      latitude_api_key:
        default: <insert your api key here>
  - url: http://api.latitude.sh
    variables:
      latitude_api_key:
        default: <insert your api key here>
security: []
tags:
  - name: API keys
  - name: Baselines (Preview)
    description: >-
      Preview. Available to teams with the `baselines_api` feature flag. The
      shape of these endpoints may change before general availability.
  - name: Billing
  - name: Elastic Ips
  - name: Events
  - name: Firewalls
  - name: IP Addresses
  - name: Managed Databases
    description: Managed database instances (PostgreSQL, ClickHouse)
  - name: Kubernetes Clusters
  - name: LKS
  - name: Marketplace apps
  - name: Operating Systems
  - name: Plans
  - name: Public Networks
  - name: Private Networks
  - name: Projects
  - name: Regions
  - name: Roles
  - name: SSH Keys
  - name: Servers
  - name: Block Storage
  - name: Filesystem Storage
  - name: Object Storage
  - name: Tags
  - name: Teams
  - name: Team members
  - name: Traffic
  - name: User data
  - name: User profile
  - name: VPN Sessions
  - name: Virtual machines
  - name: Virtual machine backups
  - name: Virtual machine restores
paths:
  /lks/clusters:
    get:
      tags:
        - LKS
      summary: List LKS clusters
      description: >
        Lists every LKS cluster of a project. The response is not paginated;
        `meta.total` is the number of clusters returned.
      operationId: list-lks-clusters
      parameters:
        - name: project_id
          in: query
          required: true
          description: >-
            Project `id_hash` or slug. Required — clusters are always scoped to
            a project.
          schema:
            type: string
          example: proj_6059EqYkOQj8p
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              examples:
                OneCluster:
                  value:
                    data:
                      - id: lksc_pRMLydp0dQKr1
                        type: lks_clusters
                        attributes:
                          name: production
                          description: ''
                          project_id: proj_6059EqYkOQj8p
                          site: DAL2
                          status: ready
                          message: ''
                          reason: ''
                          control_plane_endpoint: https://lksc-prmlydp0dqkr1.lks.latitude.sh:6443
                          kubeconfig_url: /lks/clusters/lksc_pRMLydp0dQKr1/kubeconfig
                          kubernetes_version: 1.36.3
                          platform_version: lks-v1.36.3-002
                          network:
                            pod_cidrs:
                              - 10.0.0.0/12
                            service_cidrs:
                              - 10.96.0.0/15
                            node_cidrs:
                              - 10.16.0.0/21
                          created_at: '2026-09-01T12:00:00Z'
                          updated_at: '2026-09-01T12:18:00Z'
                    meta:
                      total: 1
                Empty:
                  value:
                    data: []
                    meta:
                      total: 0
              schema:
                $ref: '#/components/schemas/lks_clusters'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              examples:
                InsufficientPermissions:
                  summary: The member role cannot perform this action
                  value:
                    errors:
                      - code: USER_AUTHORIZATION_ERROR
                        title: User Authorization Error
                        detail: You are not authorized to perform this action.
                        status: '403'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              examples:
                ProjectNotFound:
                  summary: Unknown project, or a project owned by another team
                  value:
                    errors:
                      - code: NOT_FOUND
                        title: Cluster Not Found
                        detail: Project 'proj_6059EqYkOQj8p' not found
                        status: '404'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
        '502':
          description: Bad Gateway — NetBox is temporarily unavailable
          content:
            application/vnd.api+json:
              examples:
                UpstreamServiceError:
                  value:
                    errors:
                      - code: UPSTREAM_SERVICE_ERROR
                        title: Bad Gateway
                        detail: NetBox is temporarily unavailable. Please try again.
                        status: '502'
                        meta: {}
              schema:
                $ref: '#/components/schemas/error_object'
      security:
        - Bearer: []
      x-codeSamples:
        - lang: go
          label: Go (SDK)
          source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tlatitudeshgosdk \"github.com/latitudesh/latitudesh-go-sdk\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := latitudeshgosdk.New(\n        latitudeshgosdk.WithSecurity(os.Getenv(\"LATITUDESH_BEARER\")),\n    )\n\n    res, err := s.Lks.ListLksClusters(ctx, \"proj_6059EqYkOQj8p\")\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.LksClusters != nil {\n        // handle response\n    }\n}"
components:
  schemas:
    lks_clusters:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/lks_cluster_data'
        meta:
          type: object
          properties:
            total:
              type: integer
    error_object:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                nullable: true
              status:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
                  parameter:
                    type: string
              meta:
                type: object
    lks_cluster_data:
      type: object
      properties:
        id:
          type: string
          example: lksc_pRMLydp0dQKr1
        type:
          type: string
          enum:
            - lks_clusters
        attributes:
          type: object
          properties:
            name:
              type: string
            description:
              type: string
              nullable: true
            project_id:
              type: string
              nullable: true
            site:
              type: string
              nullable: true
            status:
              type: string
              nullable: true
              description: Lifecycle state (open enum, sourced from NetBox/controller)
              example: provisioning
            message:
              type: string
              nullable: true
            reason:
              type: string
              nullable: true
              description: Machine-readable status reason (open enum)
            control_plane_endpoint:
              type: string
              nullable: true
            kubeconfig_url:
              type: string
              nullable: true
            kubernetes_version:
              type: string
              nullable: true
              example: 1.36.3
            platform_version:
              type: string
              nullable: true
              example: lks-v1.36.3-002
            network:
              type: object
              description: >-
                Configured cluster CIDRs. Always present: the ranges are columns
                on the cluster with platform defaults.
              properties:
                pod_cidrs:
                  type: array
                  items:
                    type: string
                service_cidrs:
                  type: array
                  items:
                    type: string
                node_cidrs:
                  type: array
                  items:
                    type: string
            created_at:
              type: string
              nullable: true
            updated_at:
              type: string
              nullable: true
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header

````