Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform Configs (v3) API

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /kafka/v3/clusters/{cluster_id}/broker-configs List a cluster's dynamic broker configs · List Dynamic Broker Configs #
Ask an LLM
“Which broker settings have been dynamically overridden on my Kafka cluster?”
“Can I see all cluster-wide dynamic broker configuration in Confluent Cloud?”
Tell an agent
List the dynamic broker configs on cluster {cluster_id}.
Show every cluster-wide broker override set on Kafka cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/broker-configs:alter Change several broker configs at once · Batch Alter Dynamic Broker Configs #
Ask an LLM
“How do I update multiple cluster-wide broker settings in one request?”
“Can I dry-run a batch of broker config changes before applying them?”
Tell an agent
Apply this batch of broker config changes {data} to cluster {cluster_id}.
Validate only, without applying, the broker config batch {data} on cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Get one dynamic broker config · Get Dynamic Broker Config #
Ask an LLM
“What is the current value of a specific broker setting on my cluster?”
“Is a particular broker config overridden cluster-wide or at its default?”
Tell an agent
Get broker config {name} on cluster {cluster_id}.
Show me the dynamic broker setting {name} for Kafka cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Set a single broker config value · Update Dynamic Broker Config #
Ask an LLM
“How do I change just one cluster-wide broker setting?”
“Can I set a single dynamic broker config to a new value?”
Tell an agent
Set broker config {name} to {value} on cluster {cluster_id}.
Update the dynamic broker setting {name} on Kafka cluster {cluster_id}.
DELETE /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Reset a broker config to its default · Reset Dynamic Broker Config #
Ask an LLM
“How do I put a broker setting back to its default value?”
“Can I remove a cluster-wide dynamic broker override?”
Tell an agent destructive · confirm first
Reset broker config {name} to default on cluster {cluster_id}.
Remove the dynamic broker override {name} from Kafka cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs List a topic's configs · List Topic Configs #
Ask an LLM
“What configuration settings does one of my Kafka topics have?”
“Where can I see retention and cleanup settings for a single topic?”
Tell an agent
List the configs for topic {topic_name} on cluster {cluster_id}.
Show all configuration parameters of topic {topic_name} in cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter Change several topic configs at once · Batch Alter Topic Configs #
Ask an LLM
“How do I update multiple settings on a topic in one call?”
“Can I validate a batch of topic config changes without applying them?”
Tell an agent
Apply the config changes {data} to topic {topic_name} on cluster {cluster_id}.
Dry-run the topic config batch {data} for topic {topic_name} on cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Get one topic config value · Get Topic Config #
Ask an LLM
“What is a single config value, like retention.ms, set to on my topic?”
“Is one topic setting using its default or an override?”
Tell an agent
Get config {name} for topic {topic_name} on cluster {cluster_id}.
Show the value of setting {name} on topic {topic_name} in cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Set a single topic config value · Update Topic Config #
Ask an LLM
“How do I change the retention period on one Kafka topic?”
“Can I update just one config on a topic without touching the rest?”
Tell an agent
Set config {name} to {value} on topic {topic_name} in cluster {cluster_id}.
Change topic {topic_name} setting {name} on cluster {cluster_id}.
DELETE /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Reset a topic config to its default · Reset Topic Config #
Ask an LLM
“How do I revert a topic setting back to the default?”
“Can I clear an override on one topic config?”
Tell an agent destructive · confirm first
Reset config {name} on topic {topic_name} in cluster {cluster_id} to default.
Remove the {name} override from topic {topic_name} on cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/topics/-/configs List configs for every topic in a cluster · List All Topic Configs #
Ask an LLM
“Can I pull the configuration of all topics on a cluster in one request?”
“Which topics across my cluster have non-default settings?”
Tell an agent
List configs for all topics on cluster {cluster_id}.
Export every topic's configuration parameters from Kafka cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs Preview default configs for a new topic · List New Topic Default Configs #
Ask an LLM
“What default settings would a topic get if I created it now?”
“Which config values does a newly created topic inherit?”
Tell an agent
Show the default configs topic {topic_name} would get if newly created on cluster {cluster_id}.
List new-topic default configuration for {topic_name} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs List a group's configs · List all configs of the group #
Ask an LLM
“What configurations are set on a consumer, share or streams group?”
“Can I see all settings for one Kafka group?”
Tell an agent
List the configs of group {group_id} on cluster {cluster_id}.
Show every configuration for Kafka group {group_id} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Get one group config value · Get group config #
Ask an LLM
“What is one specific setting on my consumer group set to?”
“Can I read a single config for a share or streams group?”
Tell an agent
Get config {name} for group {group_id} on cluster {cluster_id}.
Show the value of group setting {name} for {group_id} in cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Set a single group config value · Update group config #
Ask an LLM
“How do I change one setting on a Kafka consumer group?”
“Can I override a single config for a streams group?”
Tell an agent
Set group config {name} to {value} for group {group_id} on cluster {cluster_id}.
Override setting {name} with {value} on Kafka group {group_id} in cluster {cluster_id}.
DELETE /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Remove a group config override · Delete group config #
Ask an LLM
“How do I drop a config override so a group falls back to the default?”
“What happens when I delete a dynamic config on a consumer group?”
Tell an agent destructive · confirm first
Delete the {name} override on group {group_id} in cluster {cluster_id}.
Revert group {group_id} setting {name} to the default on cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter Change several group configs at once · Batch Alter Group Configs #
Ask an LLM
“Can I alter several settings on a consumer group in a single request?”
“Is there a validate-only mode for batch group config changes?”
Tell an agent
Apply the config batch {data} to group {group_id} on cluster {cluster_id}.
Validate without applying the group config batch {data} for {group_id} in cluster {cluster_id}.

Documentation

📖
Documentation
https://docs.confluent.io/cloud/current/api.html
📖
APIReference
https://docs.confluent.io/cloud/current/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-configs-v3-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/mcp/confluent-the-data-streaming-platform-tool-crosswalk.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/data-model/confluent-the-data-streaming-platform-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluent-the-data-streaming-platform:confluent-the-data-streaming-platform-configs-v3-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

confluent-the-data-streaming-platform-configs-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud Configs (v3) API
  version: ''
  x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
  x-audience: external-public
  x-logo:
    url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
  description: '# Introduction


    Note


    This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-configs-v3-api-openapi.yml