---
title: "modify cluster"
method: PUT
path: "/cluster/{clusterKey}"
tags: ["Cluster"]
---

# modify cluster

`PUT /cluster/{clusterKey}`

Modify an existing cluster

## Path parameters

- `clusterKey` string, required

## Request body

- Cluster
  - `cluster_key` string, required
  - `zone_key` string, required
  - `name` string, required
  - `require_tls` boolean — Experimental: If set, requests to this collection of hosts will be made via HTTPS. At this time neither certificate validation and certificate pinning are supported for proxy clients of this cluster.
  - `instances` Instance[]
    - `host` string
    - `port` integer
    - `metadata` Metadatum[]
      - `key` string
      - `value` string
  - `circuit_breakers` CircuitBreakers — Provides limits on various parameters to protect clusters against sudden surges in traffic.
    - `max_connections` integer — Maximum number of connections that will be established to all instances in a cluster within a proxy. If set to 0, no new connections will be created. If not specified, defaults to 1024.
    - `max_pending_requests` integer — Maximum number of requests that will be queued while waiting on a connection pool to a cluster within a proxy. If set to 0, no requests will be queued. If not specified, defaults to 1024.
    - `max_retries` integer — Maximum number of retries that can be outstanding to all instances in a cluster within a proxy. If set to 0, requests will not be retried. If not specified, defaults to 3.
    - `max_requests` integer — Maximum number of requests that can be outstanding to all instances in a cluster within a proxy. Only applicable to HTTP/2 traffic since HTTP/1.1 clusters are governed by the maximum connections circuit breaker. If set to 0, no requests will be made. If not specified, defaults to 1024.
  - `checksum` string, required

## Response `200`

A result containing the modified cluster

- ClusterResult
  - `result` Cluster
    - `cluster_key` string, required
    - `zone_key` string, required
    - `name` string, required
    - `require_tls` boolean — Experimental: If set, requests to this collection of hosts will be made via HTTPS. At this time neither certificate validation and certificate pinning are supported for proxy clients of this cluster.
    - `instances` Instance[]
      - `host` string
      - `port` integer
      - `metadata` Metadatum[]
        - `key` string
        - `value` string
    - `circuit_breakers` CircuitBreakers — Provides limits on various parameters to protect clusters against sudden surges in traffic.
      - `max_connections` integer — Maximum number of connections that will be established to all instances in a cluster within a proxy. If set to 0, no new connections will be created. If not specified, defaults to 1024.
      - `max_pending_requests` integer — Maximum number of requests that will be queued while waiting on a connection pool to a cluster within a proxy. If set to 0, no requests will be queued. If not specified, defaults to 1024.
      - `max_retries` integer — Maximum number of retries that can be outstanding to all instances in a cluster within a proxy. If set to 0, requests will not be retried. If not specified, defaults to 3.
      - `max_requests` integer — Maximum number of requests that can be outstanding to all instances in a cluster within a proxy. Only applicable to HTTP/2 traffic since HTTP/1.1 clusters are governed by the maximum connections circuit breaker. If set to 0, no requests will be made. If not specified, defaults to 1024.
    - `checksum` string, required

## Other responses

- `default` — Unexpected error

## Changes

- **2018-03-23** `42600a086ded` — 1 info
  - endpoint added
- **2017-02-02** `f370f7dbbd05` — 1 breaking
  - api removed without deprecation

[Change history](https://skmtc.dev/turbinelabs/apis/turbine-labs-api/changes/cluster/:clusterKey/put.md)

---

[API](https://skmtc.dev/turbinelabs/apis/turbine-labs-api.md) · [All operations](https://skmtc.dev/turbinelabs/apis/turbine-labs-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/turbinelabs/turbine-labs-api/revisions/42600a086ded/schema)