Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform 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 encryption keys · List of Keys #
Ask an LLM
“Which self-managed encryption keys have I registered for my clusters?”
“Can I filter my BYOK keys by cloud provider or state?”
Tell an agent
List my BYOK keys.
List BYOK keys from cloud {provider} in state {state}.
POST /byok/v1/keys Register a bring-your-own encryption key · Create a Key #
Ask an LLM
“How do I register my own KMS key to encrypt a dedicated cluster?”
“Can I add a customer-managed key from my cloud provider?”
Tell an agent
Register BYOK key {key} named {display_name}.
Create a self-managed encryption key from {key}.
GET /byok/v1/keys/{id} Get a bring-your-own key · Read a Key #
Ask an LLM
“Has my self-managed encryption key passed validation?”
“What cloud key does a BYOK record point to?”
Tell an agent
Get BYOK key {id}.
Show the validation status of BYOK key {id}.
PATCH /byok/v1/keys/{id} Rename a bring-your-own key · Update a Key #
Ask an LLM
“How do I change the display name of a BYOK key?”
“Can I update a self-managed key record after registering it?”
Tell an agent
Rename BYOK key {id} to {display_name}.
Update BYOK key record {id}.
DELETE /byok/v1/keys/{id} Delete a bring-your-own key · Delete a Key #
Ask an LLM
“How do I remove a self-managed encryption key I registered?”
“Can I delete a BYOK key that no cluster uses?”
Tell an agent destructive · confirm first
Delete BYOK key {id}.
Remove self-managed encryption key {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-keys-byok-v1-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-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-the-data-streaming-platform-keys-byok-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud 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: '# 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 (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-keys-byok-v1-api-openapi.yml