## List NKS Clusters

**get** `/v1/nks/clusters`

List all NKS clusters

### Query Parameters

- `project_id: string`

  Project ID of resources to request

- `cursor: optional string`

  Pagination cursor returned by a previous request

- `limit: optional number`

  Maximum number of items to return

### Returns

- `NKSClusterList object { items, pagination }`

  - `items: array of NKSCluster`

    - `id: string`

      Unique identifier for the Cluster.

    - `autoscaling: boolean`

      Whether autoscaling is enabled for the Cluster.

    - `created_at: string`

      When the Cluster was created.

    - `kubernetes_version: string`

      Kubernetes version of the Cluster.

    - `name: string`

      Name of the Cluster.

    - `pool_ids: array of string`

      IDs of pools belonging to this Cluster.

    - `private_ip: string`

      Private IP (VIP) of the Cluster.

    - `project_id: string`

      Project ID the Cluster belongs to.

    - `public_ip: string`

      Public IP of the Cluster.

    - `region: RegionName`

      Region the resource is in.

      - `"us-sva-2"`

    - `status: ResourceStatus`

      Status of the resource.

      - `"pending"`

      - `"creating"`

      - `"updating"`

      - `"ready"`

      - `"deleting"`

      - `"deleted"`

      - `"error"`

    - `tags: array of string`

      Tags attached to the Cluster.

    - `updated_at: string`

      When the Cluster was last updated.

    - `vpc_id: string`

      ID of the VPC the Cluster is in.

  - `pagination: Pagination`

    Pagination response details.

    - `next_cursor: string`

    - `previous_cursor: string`

    - `total_count: number`

### Example

```http
curl https://api.nirvanalabs.io/v1/nks/clusters \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY"
```

#### Response

```json
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "autoscaling": true,
      "created_at": "2025-01-01T00:00:00Z",
      "kubernetes_version": "v1.34.4",
      "name": "my-cluster",
      "pool_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "private_ip": "10.0.0.254",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "public_ip": "198.51.100.1",
      "region": "us-sva-2",
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "updated_at": "2025-01-01T00:00:00Z",
      "vpc_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}
```