PUT

/v1/clusters/{clusterArn}/nodes/count

http://kafka.{region}.amazonaws.com/v1/clusters/{clusterArn}/nodes/count

Updates the number of broker nodes in the cluster.

Access Token Required: API Key

Path Parameters

clusterArnstringrequired

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Body Params

currentVersionstringrequired

The version of cluster to update from. A successful operation will then generate a new version.

targetNumberOfBrokerNodesintegerrequired

The number of broker nodes that you want the cluster to have after this operation completes successfully.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://kafka.{region}.amazonaws.com/v1/clusters/{clusterArn}/nodes/count' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT