---
title: "Change a cluster"
description: "Asynchronous. mode (single to replicated only: 409 mode_downgrade_not_supported) and engineVersion (newer only: 409 downgrade_not_supported) each change on their own. Storage only grows, and grows while the cluster is storage_low."
---

> 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

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

Asynchronous. mode (single to replicated only: 409 mode_downgrade_not_supported) and engineVersion (newer only: 409 downgrade_not_supported) each change on their own. Storage only grows, and grows while the cluster is storage_low.

## Authentication

Requires one of the following:

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

## Path parameters

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

## Request body

_Required._

- `UpdateCluster.allowedSourceCidrs` (array<string>, optional) — IPv4 CIDRs that may reach the client ports. Default: the VPC's ranges.
- `UpdateCluster.deletionProtection` (boolean, optional)
- `UpdateCluster.description` (string | null, optional)
  - maxLength 500
- `UpdateCluster.engineVersion` (string, optional)
- `UpdateCluster.instanceType` (string, optional)
- `UpdateCluster.maintenance` (object, optional)
  - `UpdateCluster.maintenance.windowUtc` (string, optional)
- `UpdateCluster.mode` (string, optional)
  - one of `"replicated"`
- `UpdateCluster.name` (string, optional)
  - minLength 1; maxLength 100
- `UpdateCluster.plaintextPort` (boolean, optional) — Also serve password over plaintext inside the VPC, for apps that can't do TLS. Default false.
- `UpdateCluster.raiseAppTopics` (boolean, optional) — Kafka, with mode replicated: also give every topic an app created three copies. Default false: growth raises Kafka's internal topics and topics created through EZGH without a factor.
- `UpdateCluster.settings` (object, optional) — Kafka's cluster settings; RabbitMQ clusters take none ({}).
  - `UpdateCluster.settings.autoCreateTopics` (boolean, optional) — Whether a topic a client names is created with the cluster's defaults. Default true.
  - `UpdateCluster.settings.defaultPartitions` (integer, optional) — Partitions of an auto-created topic. Default 1.
    - min 1; max 100
  - `UpdateCluster.settings.defaultRetentionMs` (integer, optional) — -1 keeps messages; else 60000 to a year. Default a week.
- `UpdateCluster.storage` (object, optional)
  - `UpdateCluster.storage.iops` (integer, optional)
  - `UpdateCluster.storage.sizeGiB` (integer, optional)
    - min 10
  - `UpdateCluster.storage.throughputMBps` (integer, optional)
  - `UpdateCluster.storage.volumeType` (string, optional)
    - one of `"gp1"`
- `UpdateCluster.tags` (map<string>, optional) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `UpdateCluster.unauthenticatedAccess` (object, optional) — Kafka only. Off by default; access defaults to readOnly.
  - `UpdateCluster.unauthenticatedAccess.access` (string, optional)
    - one of `"readWrite"`, `"readOnly"`
  - `UpdateCluster.unauthenticatedAccess.enabled` (boolean, optional)

## Example request

```json
{
  "allowedSourceCidrs": [
    "string"
  ],
  "deletionProtection": true,
  "description": "string",
  "engineVersion": "string",
  "instanceType": "string",
  "maintenance": {
    "windowUtc": "string"
  },
  "mode": "replicated",
  "name": "string",
  "plaintextPort": true,
  "raiseAppTopics": true,
  "settings": {
    "autoCreateTopics": true,
    "defaultPartitions": 1,
    "defaultRetentionMs": 0
  },
  "storage": {
    "iops": 0,
    "sizeGiB": 10,
    "throughputMBps": 0,
    "volumeType": "gp1"
  },
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "unauthenticatedAccess": {
    "access": "readWrite",
    "enabled": true
  }
}
```

## Code samples

### cURL

```curl
curl --request PATCH \
  --url https://hostedqueues-api.ezghcloud.com/v1/organizations/string/projects/string/clusters/string \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowedSourceCidrs": [
    "string"
  ],
  "deletionProtection": true,
  "description": "string",
  "engineVersion": "string",
  "instanceType": "string",
  "maintenance": {
    "windowUtc": "string"
  },
  "mode": "replicated",
  "name": "string",
  "plaintextPort": true,
  "raiseAppTopics": true,
  "settings": {
    "autoCreateTopics": true,
    "defaultPartitions": 1,
    "defaultRetentionMs": 0
  },
  "storage": {
    "iops": 0,
    "sizeGiB": 10,
    "throughputMBps": 0,
    "volumeType": "gp1"
  },
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "unauthenticatedAccess": {
    "access": "readWrite",
    "enabled": true
  }
}
'
```

### TypeScript

```typescript
const url = 'https://hostedqueues-api.ezghcloud.com/v1/organizations/string/projects/string/clusters/string';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    allowedSourceCidrs: ['string'],
    deletionProtection: true,
    description: 'string',
    engineVersion: 'string',
    instanceType: 'string',
    maintenance: {windowUtc: 'string'},
    mode: 'replicated',
    name: 'string',
    plaintextPort: true,
    raiseAppTopics: true,
    settings: {autoCreateTopics: true, defaultPartitions: 1, defaultRetentionMs: 0},
    storage: {iops: 0, sizeGiB: 10, throughputMBps: 0, volumeType: 'gp1'},
    tags: {property1: 'string', property2: 'string'},
    unauthenticatedAccess: {access: 'readWrite', enabled: true}
  })
};

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"

payload = {
    "allowedSourceCidrs": ["string"],
    "deletionProtection": True,
    "description": "string",
    "engineVersion": "string",
    "instanceType": "string",
    "maintenance": { "windowUtc": "string" },
    "mode": "replicated",
    "name": "string",
    "plaintextPort": True,
    "raiseAppTopics": True,
    "settings": {
        "autoCreateTopics": True,
        "defaultPartitions": 1,
        "defaultRetentionMs": 0
    },
    "storage": {
        "iops": 0,
        "sizeGiB": 10,
        "throughputMBps": 0,
        "volumeType": "gp1"
    },
    "tags": {
        "property1": "string",
        "property2": "string"
    },
    "unauthenticatedAccess": {
        "access": "readWrite",
        "enabled": True
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 202

The operation, which Location names; poll it until it finishes.

#### Example

```json
{
  "action": "string",
  "cancellable": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "type": "user"
  },
  "error": {},
  "finishedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "queued",
  "target": {
    "id": "string",
    "resourceName": "string",
    "type": "string"
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `UpdateCluster.response.202.action` (string, required)
- `UpdateCluster.response.202.cancellable` (boolean, required)
- `UpdateCluster.response.202.createdAt` (string, required)
  - format `date-time`
- `UpdateCluster.response.202.createdBy` (object, required)
  - `UpdateCluster.response.202.createdBy.id` (string, required)
  - `UpdateCluster.response.202.createdBy.type` (unknown, required)
    - one of `"user"`, `"bot"`
- `UpdateCluster.response.202.error` (object | null, required) — A failed operation's error, { code, message }.
- `UpdateCluster.response.202.finishedAt` (string | null, required)
  - format `date-time`
- `UpdateCluster.response.202.id` (string, required)
  - format `uuid`
- `UpdateCluster.response.202.organizationId` (string, required)
  - format `uuid`
- `UpdateCluster.response.202.projectId` (string | null, required)
  - format `uuid`
- `UpdateCluster.response.202.startedAt` (string | null, required)
  - format `date-time`
- `UpdateCluster.response.202.status` (unknown, required)
  - one of `"queued"`, `"running"`, `"succeeded"`, `"failed"`, `"cancelled"`
- `UpdateCluster.response.202.target` (object, required)
  - `UpdateCluster.response.202.target.id` (string, required)
  - `UpdateCluster.response.202.target.resourceName` (string, required)
  - `UpdateCluster.response.202.target.type` (string, required)
- `UpdateCluster.response.202.type` (string, required)
- `UpdateCluster.response.202.updatedAt` (string, required)
  - format `date-time`

### 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"
    }
  }
}
```

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

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

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

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

### 409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 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"
    }
  }
}
```

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

### 413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

#### 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"
    }
  }
}
```

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

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

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

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


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