---
title: "List clusters"
---

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

Path: Kubernetes API

`GET /v1/organizations/{orgId}/projects/{projectId}/clusters`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListClusters.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `ListClusters.path.projectId` (string, required) — UUID or prefixed ID (prj_…)

## Query parameters

- `ListClusters.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `20`
- `ListClusters.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://kubernetes-api.ezghcloud.com/v1/organizations/string/projects/string/clusters \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://kubernetes-api.ezghcloud.com/v1/organizations/string/projects/string/clusters';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://kubernetes-api.ezghcloud.com/v1/organizations/string/projects/string/clusters"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of clusters.

#### Example

```json
{
  "clusters": [
    {
      "bot": "string",
      "certificateAuthority": "string",
      "controlPlaneMetrics": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "encryptionKey": "string",
      "endpoint": {
        "hostname": "string",
        "privateAddresses": [
          "string"
        ],
        "privateHostname": "string",
        "publicAccessCidrs": [
          "string"
        ],
        "publicIpv4": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "logging": {
        "obsProject": "string",
        "types": [
          "string"
        ]
      },
      "maintenanceWindow": {
        "day": "string",
        "startHour": 23
      },
      "name": "string",
      "nodeFirewall": "string",
      "oidcIssuer": "string",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "patchVersion": "string",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "region": "string",
      "resourceName": "string",
      "serviceIpv4Cidr": "string",
      "serviceIpv6Cidr": "string",
      "slug": "string",
      "status": "string",
      "subnet": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "version": "string",
      "vpc": "string"
    }
  ],
  "nextCursor": "string"
}
```

- `ListClusters.response.200.clusters` (array<object>, required)
  - `ListClusters.response.200.clusters.bot` (string, required) — The cluster Bot (bot_…) its controllers act as.
  - `ListClusters.response.200.clusters.certificateAuthority` (string | null, required) — The cluster CA's certificate, PEM. null until the cluster is active.
  - `ListClusters.response.200.clusters.controlPlaneMetrics` (boolean, required) — Whether the control plane's metrics (apiserver, etcd, scheduler and controller manager) go to the cluster's project in Obs, free.
  - `ListClusters.response.200.clusters.createdAt` (string, required)
    - format `date-time`
  - `ListClusters.response.200.clusters.encryptionKey` (string | null, required) — The Keys key (kms_…) Secrets are encrypted with, or null for an EZGH-managed key. Fixed at create.
  - `ListClusters.response.200.clusters.endpoint` (object, required)
    - `ListClusters.response.200.clusters.endpoint.hostname` (string, required)
    - `ListClusters.response.200.clusters.endpoint.privateAddresses` (array<string>, required)
    - `ListClusters.response.200.clusters.endpoint.privateHostname` (string, required)
    - `ListClusters.response.200.clusters.endpoint.publicAccessCidrs` (array<string>, required)
    - `ListClusters.response.200.clusters.endpoint.publicIpv4` (string | null, required)
  - `ListClusters.response.200.clusters.id` (string, required)
    - format `uuid`
  - `ListClusters.response.200.clusters.logging` (object, required)
    - `ListClusters.response.200.clusters.logging.obsProject` (string | null, required)
    - `ListClusters.response.200.clusters.logging.types` (array<string>, required)
  - `ListClusters.response.200.clusters.maintenanceWindow` (object, required)
    - `ListClusters.response.200.clusters.maintenanceWindow.day` (string, required)
    - `ListClusters.response.200.clusters.maintenanceWindow.startHour` (integer, required)
      - min 0; max 23
  - `ListClusters.response.200.clusters.name` (string, required)
  - `ListClusters.response.200.clusters.nodeFirewall` (string | null, required)
  - `ListClusters.response.200.clusters.oidcIssuer` (string, required)
  - `ListClusters.response.200.clusters.organizationId` (string, required)
    - format `uuid`
  - `ListClusters.response.200.clusters.patchVersion` (string | null, required)
  - `ListClusters.response.200.clusters.projectId` (string, required)
    - format `uuid`
  - `ListClusters.response.200.clusters.region` (string, required)
  - `ListClusters.response.200.clusters.resourceName` (string, required)
  - `ListClusters.response.200.clusters.serviceIpv4Cidr` (string, required)
  - `ListClusters.response.200.clusters.serviceIpv6Cidr` (string, required)
  - `ListClusters.response.200.clusters.slug` (string, required)
  - `ListClusters.response.200.clusters.status` (string, required) — creating, active, updating, deleting or failed; clients treat others as unknown.
  - `ListClusters.response.200.clusters.subnet` (string, required)
  - `ListClusters.response.200.clusters.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
  - `ListClusters.response.200.clusters.updatedAt` (string, required)
    - format `date-time`
  - `ListClusters.response.200.clusters.version` (string, required) — The Kubernetes minor version, such as 1.37.
  - `ListClusters.response.200.clusters.vpc` (string, required)
- `ListClusters.response.200.nextCursor` (string | null, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.400.error` (object, required)
  - `ListClusters.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.400.error.issues.message` (string, required)
    - `ListClusters.response.400.error.issues.path` (string, required)
  - `ListClusters.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.400.error.quota.id` (string, required)
    - `ListClusters.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.400.error.quota.region` (string, optional)
    - `ListClusters.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.401.error` (object, required)
  - `ListClusters.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.401.error.issues.message` (string, required)
    - `ListClusters.response.401.error.issues.path` (string, required)
  - `ListClusters.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.401.error.quota.id` (string, required)
    - `ListClusters.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.401.error.quota.region` (string, optional)
    - `ListClusters.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.403.error` (object, required)
  - `ListClusters.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.403.error.issues.message` (string, required)
    - `ListClusters.response.403.error.issues.path` (string, required)
  - `ListClusters.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.403.error.quota.id` (string, required)
    - `ListClusters.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.403.error.quota.region` (string, optional)
    - `ListClusters.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.404.error` (object, required)
  - `ListClusters.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.404.error.issues.message` (string, required)
    - `ListClusters.response.404.error.issues.path` (string, required)
  - `ListClusters.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.404.error.quota.id` (string, required)
    - `ListClusters.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.404.error.quota.region` (string, optional)
    - `ListClusters.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.429.error` (object, required)
  - `ListClusters.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.429.error.issues.message` (string, required)
    - `ListClusters.response.429.error.issues.path` (string, required)
  - `ListClusters.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.429.error.quota.id` (string, required)
    - `ListClusters.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.429.error.quota.region` (string, optional)
    - `ListClusters.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.500.error` (object, required)
  - `ListClusters.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.500.error.issues.message` (string, required)
    - `ListClusters.response.500.error.issues.path` (string, required)
  - `ListClusters.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.500.error.quota.id` (string, required)
    - `ListClusters.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.500.error.quota.region` (string, optional)
    - `ListClusters.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListClusters.response.503.error` (object, required)
  - `ListClusters.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListClusters.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListClusters.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListClusters.response.503.error.issues.message` (string, required)
    - `ListClusters.response.503.error.issues.path` (string, required)
  - `ListClusters.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListClusters.response.503.error.quota.id` (string, required)
    - `ListClusters.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListClusters.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListClusters.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListClusters.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListClusters.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListClusters.response.503.error.quota.region` (string, optional)
    - `ListClusters.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListClusters.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListClusters.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListClusters.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/kubernetes-api/ListClusters/index.md
