PUT

/v1/clusters/{clusterArn}/storage

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

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Access Token Required: API Key

Path Parameters

clusterArnstringrequired

The Amazon Resource Name (ARN) of the cluster to be updated.

Body Params

storageModestring

Controls storage mode for various supported storage tiers.

volumeSizeGBinteger

size of the EBS volume to update.

currentVersionstringrequired

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

provisionedThroughputobject

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

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}/storage' \
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