Confluent

Confluent Configs (v3) API

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

GitHub OpenAPI

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 overridden dynamically across my whole Kafka cluster?”
“Does the cluster-wide broker config list come back empty when nothing has been changed dynamically?”
Tell an agent
Show every dynamic broker config set on cluster {cluster_id}.
List the cluster-wide broker overrides for Kafka cluster {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/broker-configs:alter Batch alter dynamic broker configs · Batch Alter Dynamic Broker Configs #
Ask an LLM
“Can I change several cluster-wide broker settings in one request?”
“Is there a dry run to check 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 cluster-wide value of a single broker setting?”
“How do I read one named broker config on a Confluent Cloud Kafka cluster?”
Tell an agent
Get the broker config {name} on cluster {cluster_id}.
Show me the dynamic broker value of {name} for Kafka cluster {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/broker-configs/{name} Update one dynamic broker config · Update Dynamic Broker Config #
Ask an LLM
“Can I set a single cluster-wide broker setting without sending a whole batch?”
“Where do I change just one broker config value for every broker in the cluster?”
Tell an agent
Set broker config {name} to {value} on cluster {cluster_id}.
Change the cluster-wide broker setting {name} on {cluster_id} to {value}.
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 undo a dynamic broker override and go back to the default?”
“What happens to a broker setting when I delete its dynamic cluster-wide value?”
Tell an agent destructive · confirm first
Reset broker config {name} on cluster {cluster_id} to its default.
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 particular topic have?”
“Can I see retention and cleanup settings for a single topic?”
Tell an agent
List the configs of topic {topic_name} on cluster {cluster_id}.
Show all settings for topic {topic_name} in {cluster_id}.
POST /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter Batch alter a topic's configs · Batch Alter Topic Configs #
Ask an LLM
“Can I update or delete several settings on one topic at once?”
“Is there a validate-only mode for a batch of topic config changes?”
Tell an agent
Apply topic config changes {data} to topic {topic_name} on cluster {cluster_id}.
Dry-run the topic config batch {data} for {topic_name} on {cluster_id} without applying it.
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 topic's current value for one specific setting like retention.ms?”
“How do I check a single named config on a Kafka topic?”
Tell an agent
Get config {name} for topic {topic_name} on cluster {cluster_id}.
What is {name} set to on topic {topic_name} in {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Update one topic config · Update Topic Config #
Ask an LLM
“Can I change just one setting on a topic, like its retention time?”
“Does updating a topic config also let me change the partition count?”
Tell an agent
Set {name} to {value} on topic {topic_name} in cluster {cluster_id}.
Change topic {topic_name}'s {name} setting on {cluster_id} to {value}.
DELETE /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name} Reset a topic config to default · Reset Topic Config #
Ask an LLM
“How do I put a topic setting back to its default value?”
“Can I clear a custom override on one topic without touching its other settings?”
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_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 settings of all topics in a cluster in one call?”
“Which topics across my cluster have non-default configuration?”
Tell an agent
Pull settings for all topics at once across cluster {cluster_id}.
Dump all topic settings across Kafka cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs List default configs for a new topic · List New Topic Default Configs #
Ask an LLM
“What settings would a topic get if I created it fresh right now?”
“Where can I see the defaults a newly created topic would inherit?”
Tell an agent
Show the default configs topic {topic_name} would get if newly created on {cluster_id}.
List new-topic default settings for {topic_name} on 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 configuration does a consumer, share or streams group have?”
“How do I see all settings for one group on my cluster?”
Tell an agent
List all configs for group {group_id} on cluster {cluster_id}.
Show every setting of group {group_id} in {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Get one group config · Get group config #
Ask an LLM
“What value does a group have for one named setting like session timeout?”
“Can I check a single config on a share group or streams group?”
Tell an agent
Get config {name} for group {group_id} on cluster {cluster_id}.
What is {name} set to for group {group_id} in {cluster_id}.
PUT /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Update one group config · Update group config #
Ask an LLM
“Can I override a single setting for one consumer group?”
“Which call changes just one config value on a streams or share group?”
Tell an agent
Set {name} to {value} for group {group_id} on cluster {cluster_id}.
Change group {group_id}'s {name} on {cluster_id} to {value}.
DELETE /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name} Remove a group config override · Delete group config #
Ask an LLM
“What happens when I delete a group's config override?”
“How do I make a group fall back to the default for one setting?”
Tell an agent destructive · confirm first
Delete the {name} override on group {group_id} in cluster {cluster_id}.
Revert group {group_id} on {cluster_id} to the default {name}.
POST /kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter Batch alter a group's configs · Batch Alter Group Configs #
Ask an LLM
“Can I change several settings on one consumer group in a single request?”
“Is it possible to validate a batch of group config changes without applying them?”
Tell an agent
Apply group config changes {data} to group {group_id} on cluster {cluster_id}.
Validate only the group config batch {data} for {group_id} on {cluster_id}.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/openapi/confluent-configs-v3-api-openapi.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:confluent-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-configs-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent 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: 'Operations tagged Configs (v3) across 2 of this provider''s published API definitions: confluent-cloud-openapi.yaml, confluent-cloud-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


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