GET

/api/v2/clusters

http://kafka.{region}.amazonaws.com/api/v2/clusters

Returns a list of all the MSK clusters in the current Region.

Access Token Required: API Key

Query Params

clusterNameFilterstring

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

clusterTypeFilterstring

Specify either PROVISIONED or SERVERLESS.

maxResultsinteger

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

nextTokenstring

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

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 GET \
2     --url 'http://kafka.{region}.amazonaws.com/api/v2/clusters' \
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}

GET