Confluent

Confluent Keys (byok/v1) API

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) `Key` objects represent customer managed keys on dedicated Confluent Cloud clusters. Keys are used to protect data at rest stored in your dedicated Confluent Cloud clusters on AWS, Azure, and GCP. This API allows you to upload and retrieve self-managed keys on Confluent Cloud. Related guide: [Confluent Cloud Bring Your Own Key (BYOK) Management API](https://docs.confluent.io/cloud/current/clusters/byok/index.html). ## The Keys Model ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `byok.max_keys.per_org` | BYOK keys in one Confluent Cloud organisation. |

GitHub OpenAPI

Operations 5

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 /byok/v1/keys List bring-your-own-keys · List of Keys #
Ask an LLM
“Which customer-managed encryption keys have I registered?”
“Can I filter my BYOK keys by cloud provider or state?”
Tell an agent
List all my BYOK keys.
List BYOK keys from {provider} in state {state}.
POST /byok/v1/keys Register a bring-your-own-key · Create a Key #
Ask an LLM
“How do I register my own KMS key to encrypt a dedicated Kafka cluster?”
“What key details do I provide for AWS versus Azure BYOK?”
Tell an agent
Register BYOK key {key} named {display_name}.
Add a customer-managed key with details {key}.
GET /byok/v1/keys/{id} Get a bring-your-own-key · Read a Key #
Ask an LLM
“Is my registered encryption key available for cluster provisioning?”
“Can I read one BYOK key and its validation status?”
Tell an agent
Get BYOK key {id}.
Show the state and validation of key {id}.
PATCH /byok/v1/keys/{id} Update a bring-your-own-key · Update a Key #
Ask an LLM
“Can I rename a registered encryption key?”
“Which call edits a BYOK key's display name?”
Tell an agent
Rename BYOK key {id} to {display_name}.
Update key {id} with display name {display_name}.
DELETE /byok/v1/keys/{id} Delete a bring-your-own-key · Delete a Key #
Ask an LLM
“Can I remove a customer-managed key I no longer use?”
“What deletes one BYOK key record?”
Tell an agent destructive · confirm first
Delete BYOK key {id}.
Remove customer-managed key {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-keys-byok-v1-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-keys-byok-v1-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-keys-byok-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Keys (byok/v1) 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 Keys (byok/v1) 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 (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent/refs/heads/main/openapi/confluent-keys-byok-v1-api-openapi.yml