How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Amazon MSK

Amazon MSK Clusters API

The Clusters API from Amazon MSK — 18 operation(s) for clusters.

Documentation Provider Profile APIs.io OpenAPI GitHub

Amazon MSK Clusters API is one of 6 APIs that Amazon MSK publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 23 operations across 18 paths, and defines 106 schemas. It is described by OpenAPI 3.2.0, at version 2018-11-14.

Requests are made against 4 base URLs: http://kafka.{region}.amazonaws.com, https://kafka.{region}.amazonaws.com, http://kafka.{region}.amazonaws.com.cn, https://kafka.{region}.amazonaws.com.cn.

23 operations 18 paths 106 schemas 1 DELETE8 GET2 PATCH3 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2018-11-14
Base URL
http://kafka.{region}.amazonaws.com
Authentication
API Key
Contact
Mike Ralphson
License
Apache 2.0 License
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Amazon MSK Clusters API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 23

Across 18 paths, the API surfaces 23 operations — 1 DELETE, 8 GET, 2 PATCH, 3 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Clusters 23
POST
/v1/clusters/{clusterArn}/scram-secrets
Amazon MSK Batch Associate Scram Secret
BatchAssociateScramSecret 8 params body → 200480481482483484485486
PATCH
/v1/clusters/{clusterArn}/scram-secrets
Amazon MSK Batch Disassociate Scram Secret
BatchDisassociateScramSecret 8 params body → 200480481482483484485486
GET
/v1/clusters/{clusterArn}/scram-secrets
Amazon MSK List Scram Secrets
ListScramSecrets 12 params → 200480481482483484485486
POST
/v1/clusters
Amazon MSK Create Cluster
CreateCluster 7 params body → 200480481482483484485486
GET
/v1/clusters
Amazon MSK List Clusters
ListClusters 12 params → 200480481482483
POST
/api/v2/clusters
Amazon MSK Create Cluster V2
CreateClusterV2 7 params body → 200480481482483484485486
GET
/api/v2/clusters
Amazon MSK List Clusters V2
ListClustersV2 13 params → 200480481482483
DELETE
/v1/clusters/{clusterArn}
Amazon MSK Delete Cluster
DeleteCluster 9 params → 200480481482483
GET
/v1/clusters/{clusterArn}
Amazon MSK Describe Cluster
DescribeCluster 8 params → 200480481482483484
GET
/api/v2/clusters/{clusterArn}
Amazon MSK Describe Cluster V2
DescribeClusterV2 8 params → 200480481482483484
GET
/v1/clusters/{clusterArn}/bootstrap-brokers
Amazon MSK Get Bootstrap Brokers
GetBootstrapBrokers 8 params → 200480481482483484
GET
/v1/clusters/{clusterArn}/operations
Amazon MSK List Cluster Operations
ListClusterOperations 12 params → 200480481482483
GET
/v1/clusters/{clusterArn}/nodes
Amazon MSK List Nodes
ListNodes 12 params → 200480481482483
PUT
/v1/clusters/{clusterArn}/reboot-broker
Amazon MSK Reboot Broker
RebootBroker 8 params body → 200480481482483484485486
PUT
/v1/clusters/{clusterArn}/nodes/count
Amazon MSK Update Broker Count
UpdateBrokerCount 8 params body → 200480481482483484
PUT
/v1/clusters/{clusterArn}/nodes/type
Amazon MSK Update Broker Type
UpdateBrokerType 8 params body → 200480481482483484485486
PUT
/v1/clusters/{clusterArn}/nodes/storage
Amazon MSK Update Broker Storage
UpdateBrokerStorage 8 params body → 200480481482483484
PUT
/v1/clusters/{clusterArn}/connectivity
Amazon MSK Update Connectivity
UpdateConnectivity 8 params body → 200480481482483484485
PUT
/v1/clusters/{clusterArn}/configuration
Amazon MSK Update Cluster Configuration
UpdateClusterConfiguration 8 params body → 200480481482483484485
PUT
/v1/clusters/{clusterArn}/version
Amazon MSK Update Cluster Kafka Version
UpdateClusterKafkaVersion 8 params body → 200480481482483484485486
PUT
/v1/clusters/{clusterArn}/monitoring
Amazon MSK Update Monitoring
UpdateMonitoring 8 params body → 200480481482483484
PATCH
/v1/clusters/{clusterArn}/security
Amazon MSK Update Security
UpdateSecurity 8 params body → 200480481482483484485486
PUT
/v1/clusters/{clusterArn}/storage
Amazon MSK Update Storage
UpdateStorage 8 params body → 200480481482483484485486

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are ClusterInfo (19 properties), MutableClusterInfo (12 properties), ClusterOperationInfo (11 properties), Provisioned (11 properties). Each schema is shown below with its type and property counts.

__mapOf__string
object
__integer
integer
ConfigurationInfo
object
Specifies the configuration to use for the brokers.
2 properties 2 required
__listOfBrokerEBSVolumeInfo
array
__timestampIso8601
string
VpcConfig
object
The configuration of the Amazon VPCs for the cluster.
2 properties 1 required
JmxExporterInfo
object
Indicates whether you want to turn on or turn off the JMX Exporter.
1 property 1 required
InternalServerErrorException
NodeType
string
The broker or Zookeeper node.
CreateClusterResponse
object
3 properties
DescribeClusterV2Response
object
1 property
UpdateMonitoringResponse
object
2 properties
EnhancedMonitoring
string
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PERBROKER, PERTOPICPERBROKER, and PERTOPICP…
BrokerEBSVolumeInfo
object
Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the clus…
3 properties 1 required
OpenMonitoring
object
JMX and Node monitoring for the MSK cluster.
1 property 1 required
__listOfVpcConfig
array
ClusterState
string
The state of the Apache Kafka cluster.
ErrorInfo
object
Returns information about an error state of the cluster.
2 properties
UpdateClusterKafkaVersionResponse
object
2 properties
ListClustersV2Response
object
2 properties
ForbiddenException
UpdateClusterConfigurationResponse
object
2 properties
__integerMin1Max15
integer
CreateClusterV2Response
object
4 properties
__listOfClusterInfo
array
BrokerSoftwareInfo
object
Information about the current software installed on the cluster.
3 properties
__listOfNodeInfo
array
__listOfCluster
array
BrokerNodeInfo
object
BrokerNodeInfo
6 properties
ListClusterOperationsResponse
object
2 properties
LoggingInfo
object
1 property 1 required
JmxExporter
object
Indicates whether you want to turn on or turn off the JMX Exporter.
1 property 1 required
Tls
object
Details for client authentication using TLS.
2 properties
PublicAccess
object
Public access control for brokers.
1 property
ClientAuthentication
object
Includes all client authentication information.
3 properties
UpdateBrokerStorageResponse
object
2 properties
ProvisionedThroughput
object
Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
2 properties
__double
number
PrometheusInfo
object
Prometheus settings.
2 properties
Firehose
object
2 properties 1 required
Scram
object
Details for SASL/SCRAM client authentication.
1 property
Cluster
object
Returns information about a cluster.
11 properties
UnauthorizedException
EBSStorageInfo
object
Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.
2 properties
UpdateBrokerCountResponse
object
2 properties
ClusterInfo
object
Returns information about a cluster.
19 properties
__integerMin1Max16384
integer
UpdateConnectivityResponse
object
2 properties
Prometheus
object
Prometheus settings.
2 properties
MutableClusterInfo
object
Information about cluster attributes that can be updated via update APIs.
12 properties
BatchAssociateScramSecretResponse
object
2 properties
UpdateBrokerTypeResponse
object
2 properties
TooManyRequestsException
BadRequestException
__listOf__string
array
ClusterOperationStep
object
Step taken during a cluster operation.
2 properties
GetBootstrapBrokersResponse
object
7 properties
BrokerNodeGroupInfo
object
Describes the setup to be used for Apache Kafka broker nodes in the cluster.
6 properties 2 required
DeleteClusterResponse
object
2 properties
__listOfUnprocessedScramSecret
array
ListNodesResponse
object
2 properties
OpenMonitoringInfo
object
JMX and Node monitoring for the MSK cluster.
1 property 1 required
ClusterOperationInfo
object
Returns information about a cluster operation.
11 properties
S3
object
3 properties 1 required
NodeExporterInfo
object
Indicates whether you want to turn on or turn off the Node Exporter.
1 property 1 required
UpdateSecurityResponse
object
2 properties
__listOfClusterOperationStep
array
ListScramSecretsResponse
object
2 properties
__listOfClusterOperationInfo
array
__stringMin1Max128
string
ListClustersResponse
object
2 properties
EncryptionAtRest
object
The data-volume encryption details.
1 property 1 required
ClusterOperationStepInfo
object
State information about the operation step.
1 property
__long
integer
StateInfo
object
2 properties
ServerlessSasl
object
Details for client authentication using SASL.
1 property
UpdateStorageResponse
object
2 properties
Unauthenticated
object
1 property
ConflictException
Sasl
object
Details for client authentication using SASL.
2 properties
Iam
object
Details for IAM access control.
1 property
EncryptionInfo
object
Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
2 properties
StorageMode
string
Controls storage mode for various supported storage tiers.
UnprocessedScramSecret
object
Error info for scram secret associate/disassociate failure.
3 properties
BrokerAZDistribution
string
The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You…
__boolean
boolean
ZookeeperNodeInfo
object
Zookeeper node information.
5 properties
BrokerLogs
object
3 properties
NodeExporter
object
Indicates whether you want to turn on or turn off the Node Exporter.
1 property 1 required
Serverless
object
Serverless cluster.
2 properties 1 required
RebootBrokerResponse
object
2 properties
BatchDisassociateScramSecretResponse
object
2 properties
ClientBroker
string
Client-broker encryption in transit setting.
ConnectivityInfo
object
Information about the broker access configuration.
1 property
DescribeClusterResponse
object
1 property
StorageInfo
object
Contains information about storage volumes attached to MSK broker nodes.
1 property
NotFoundException
Provisioned
object
Provisioned cluster.
11 properties 2 required
NodeInfo
object
The node information object.
6 properties
CloudWatchLogs
object
2 properties 1 required
EncryptionInTransit
object
The settings for encrypting data in transit.
2 properties
ServiceUnavailableException
ServerlessClientAuthentication
object
Includes all client authentication information.
1 property
__stringMin5Max32
string
ClusterType
string
The type of cluster.
__string
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-msk-clusters-api-openapi.yml Raw ↑

Other APIs Amazon MSK publishes across the network.

Amazon MSK Compatible Kafka Versions API
AE Profile APIs.io
Amazon MSK Configurations API
AE Profile APIs.io
Amazon MSK Kafka Versions API
AE Profile APIs.io
Amazon MSK Operations API
AE Profile APIs.io
Amazon MSK Tags API
AE Profile APIs.io
#Cluster
← Back to A APIs
API Details
ID
amazon-msk:amazon-msk-clusters-api
Base URL
http://kafka.{region}.amazonaws.com
Docs
https://aws.amazon.com/msk/
Provider
Amazon MSK
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=amazon-msk-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/amazon-msk-clusters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Amazon MSK Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.