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
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 LimitsThis 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. |

Documentation Provider Profile APIs.io OpenAPI GitHub

Confluent Keys (byok/v1) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Keys (byok/v1). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.confluent.cloud.

5 operations 2 paths 11 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 6

Confluent Keys (byok/v1) API declares 6 security schemes for authenticating requests. It accepts HTTP basic authentication (cloud-api-key). It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow. It accepts HTTP basic authentication (global-api-key). It accepts HTTP basic authentication (resource-api-key). It supports OAuth 2.0 (external-access-token) using the clientCredentials flow. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.

  • cloud-api-key — Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.
  • confluent-sts-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • global-api-key — Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.
  • resource-api-key — Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…
  • external-access-token — Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.
  • oauth — Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Keys (byok/v1) 5

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) Key objects represent customer…

GET
/byok/v1/keys
List of Keys
listByokV1Keys 8 params → 200400401403429500
POST
/byok/v1/keys
Create a Key
createByokV1Key body → 201400401402403409422429
GET
/byok/v1/keys/{id}
Read a Key
getByokV1Key 1 param → 200400401403404429500
PATCH
/byok/v1/keys/{id}
Update a Key
updateByokV1Key 1 param body → 200400401402403404409422
DELETE
/byok/v1/keys/{id}
Delete a Key
deleteByokV1Key 1 param → 204400401403404429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are byok.v1.Key (9 properties), Error (8 properties), ObjectMeta (5 properties), ListMeta (5 properties). Each schema is shown below with its type and property counts.

ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties 1 required
byok.v1.GcpKey
object
The GCP BYOK details
3 properties 2 required
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
byok.v1.AwsKey
object
The AWS BYOK details
3 properties 2 required
byok.v1.Key
object
Key objects represent customer managed keys on dedicated Confluent Cloud clusters. Keys are used to protect data at rest stored in your dedicated Confluent Clo…
9 properties
byok.v1.AzureKey
object
The Azure BYOK details.
5 properties 4 required
SearchFilter
string
Filter a collection by a string search
Error
object
Describes a particular error encountered while performing an operation.
8 properties
byok.v1.KeyList
object
Key objects represent customer managed keys on dedicated Confluent Cloud clusters. Keys are used to protect data at rest stored in your dedicated Confluent Clo…
4 properties 4 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property 1 required
byok.v1.KeyValidation
object
The validation details of the key.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-keys-byok-v1-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
AE Profile APIs.io
Confluent Managed MCP Servers
AE Profile APIs.io
Confluent ACLs API
AE Profile APIs.io
Confluent API Keys API
AE Profile APIs.io
Confluent Clusters API
AE Profile APIs.io
Confluent Consumer Groups API
AE Profile APIs.io
Confluent Environments API
AE Profile APIs.io
Confluent Partitions API
AE Profile APIs.io
Confluent Service Accounts API
AE Profile APIs.io
Confluent Topics API
AE Profile APIs.io
Confluent Access Points (networking/v1) API
AE Profile APIs.io
Confluent ACL (v3) API
AE Profile APIs.io
#Keys (byok/v1)
← Back to C APIs
API Details
ID
confluent:confluent-keys-byok-v1-api
Base URL
https://api.confluent.cloud
Docs
https://www.confluent.io/
Provider
Confluent
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=confluent-keys-byok-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/confluent-keys-byok-v1-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 Confluent Keys (byok/v1) 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.