---
title: "Get a cluster"
---

> 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: Hosted Queues API

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

## Authentication

Requires one of the following:

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

## Path parameters

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

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://hostedqueues-api.ezghcloud.com/v1/organizations/string/projects/string/clusters/string';
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://hostedqueues-api.ezghcloud.com/v1/organizations/string/projects/string/clusters/string"

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

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

print(response.text)
```

## Responses

### 200

It.

#### Example

```json
{
  "allowedSourceCidrs": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "deletionProtection": true,
  "description": "string",
  "endpoint": {
    "brokers": [
      {
        "hostname": "string",
        "index": 0
      }
    ],
    "hostname": "string",
    "plaintextPort": 0,
    "port": 0,
    "unauthenticatedPort": 0
  },
  "engine": "kafka",
  "engineVersion": "string",
  "id": "string",
  "instanceType": "string",
  "maintenance": {
    "windowUtc": "string"
  },
  "mode": "single",
  "name": "string",
  "organizationId": "string",
  "plaintextPort": true,
  "projectId": "string",
  "region": "string",
  "resourceName": "string",
  "settings": {
    "autoCreateTopics": true,
    "defaultPartitions": 1,
    "defaultRetentionMs": 0
  },
  "slug": "string",
  "status": "creating",
  "storage": {
    "iops": 0,
    "sizeGiB": 10,
    "throughputMBps": 0,
    "volumeType": "gp1"
  },
  "subnet": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "unauthenticatedAccess": {
    "access": "readWrite",
    "enabled": true
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "vpc": "string"
}
```

- `GetCluster.response.200.allowedSourceCidrs` (array<string>, required)
- `GetCluster.response.200.createdAt` (string, required)
  - format `date-time`
- `GetCluster.response.200.deletionProtection` (boolean, required)
- `GetCluster.response.200.description` (string | null, required)
- `GetCluster.response.200.endpoint` (object | null, required) — How clients reach the cluster. Null until its names resolve.
  - `GetCluster.response.200.endpoint.brokers` (array | null, required) — Kafka's brokers and the names each advertises; null on RabbitMQ.
  - `GetCluster.response.200.endpoint.hostname` (string, required) — RabbitMQ: mq-<label>, every node. Kafka: kafka-<label>, the bootstrap name.
  - `GetCluster.response.200.endpoint.plaintextPort` (integer | null, required) — Password over plaintext inside the VPC (Kafka 9092 SASL_PLAINTEXT, RabbitMQ 5672 AMQP) when plaintextPort is on; null otherwise.
  - `GetCluster.response.200.endpoint.port` (integer, required) — TLS: Kafka 9093 (SASL_SSL), RabbitMQ 5671 (AMQPS).
  - `GetCluster.response.200.endpoint.unauthenticatedPort` (integer | null, required) — Kafka's TLS port with no client authentication (9091) while unauthenticatedAccess is on; null otherwise.
- `GetCluster.response.200.engine` (string, required)
  - one of `"kafka"`, `"rabbitmq"`
- `GetCluster.response.200.engineVersion` (string, required)
- `GetCluster.response.200.id` (string, required)
- `GetCluster.response.200.instanceType` (string, required) — Every node's.
- `GetCluster.response.200.maintenance` (object, required)
  - `GetCluster.response.200.maintenance.windowUtc` (string, required) — ddd:HH:MM-ddd:HH:MM in UTC.
- `GetCluster.response.200.mode` (string, required) — single is one node; replicated is three on three hosts and survives the loss of any one.
  - one of `"single"`, `"replicated"`
- `GetCluster.response.200.name` (string, required)
- `GetCluster.response.200.organizationId` (string, required)
- `GetCluster.response.200.plaintextPort` (boolean, required)
- `GetCluster.response.200.projectId` (string, required)
- `GetCluster.response.200.region` (string, required)
- `GetCluster.response.200.resourceName` (string, required)
- `GetCluster.response.200.settings` (object, required) — Kafka's cluster settings; RabbitMQ clusters take none ({}).
  - `GetCluster.response.200.settings.autoCreateTopics` (boolean, optional) — Whether a topic a client names is created with the cluster's defaults. Default true.
  - `GetCluster.response.200.settings.defaultPartitions` (integer, optional) — Partitions of an auto-created topic. Default 1.
    - min 1; max 100
  - `GetCluster.response.200.settings.defaultRetentionMs` (integer, optional) — -1 keeps messages; else 60000 to a year. Default a week.
- `GetCluster.response.200.slug` (string, required) — The hqc_ ID every reference uses.
- `GetCluster.response.200.status` (string, required) — degraded: a replicated cluster serving with a node being replaced. recovering: a single-node cluster being replaced. storage_low: a node's storage is 85% full.
  - one of `"creating"`, `"available"`, `"modifying"`, `"upgrading"`, `"recovering"`, `"degraded"`, `"storage_low"`, `"deleting"`, `"deleted"`, `"failed"`
- `GetCluster.response.200.storage` (object, required)
  - `GetCluster.response.200.storage.iops` (integer, required)
  - `GetCluster.response.200.storage.sizeGiB` (integer, required)
    - min 10
  - `GetCluster.response.200.storage.throughputMBps` (integer, required)
  - `GetCluster.response.200.storage.volumeType` (string, required)
    - one of `"gp1"`
- `GetCluster.response.200.subnet` (string, required)
- `GetCluster.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `GetCluster.response.200.unauthenticatedAccess` (object | null, required) — Kafka only: a TLS listener on 9091 with no client authentication, for apps that can't do SASL, reachable only from allowedSourceCidrs and firewall peers. Null on RabbitMQ.
  - `GetCluster.response.200.unauthenticatedAccess.access` (string, required)
    - one of `"readWrite"`, `"readOnly"`
  - `GetCluster.response.200.unauthenticatedAccess.enabled` (boolean, required)
- `GetCluster.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetCluster.response.200.vpc` (string, 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"
    }
  }
}
```

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

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

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

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

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

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

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


Source: https://docs.ezghcloud.com/hostedqueues-api/GetCluster/index.md
