# Confluent Cloud APIs

> The Confluent Cloud REST API manages organizations, environments, Kafka
> clusters, schemas, connectors, Flink compute pools, networking, and related
> resources. Control-plane only — data-plane produce/consume uses native
> Kafka protocols.

Base URL: https://api.confluent.cloud
Authentication: Cloud API keys via HTTP Basic auth (`cloud-api-key`), OAuth 2.0 via STS (`confluent-sts-access-token`), resource-specific API keys (`resource-api-key`), external OAuth (`external-access-token`), Partner OAuth (`oauth`).
Versioning: per sub-API (e.g. iam/v2, cmk/v2, networking/v1). Each endpoint carries a lifecycle stage — General Availability, Early Access, Limited Availability, or Preview — exposed via the `x-lifecycle-stage` OpenAPI extension.
Errors: RFC 9457 Problem Details format.
Coverage: Broad control-plane API surface spanning many operations, tags, and sub-API groups; see the linked OpenAPI spec for the current inventory.

## API specification

- [Confluent Cloud API Reference in Markdown](https://docs.confluent.io/cloud/current/api.md): The complete API reference — overview, authentication, and every endpoint with its parameters, request body, and responses — as a single Markdown file. Preferred entry point for LLMs and agents: plain text, no HTML or JS to parse, fits in one context window.
- [OpenAPI 3.0 spec (YAML)](https://docs.confluent.io/cloud/current/openapi.yaml): Full machine-readable reference for the current API surface, including schema definitions.
- [Interactive HTML docs](https://docs.confluent.io/cloud/current): Human-readable reference with search, dark mode toggle, and auto-generated code samples.

## Sub-APIs

### Identity Access Management (v2)
API keys, users, service accounts, invitations, IP groups, IP filters, IP filter summaries, role bindings, identity providers, jwks, identity pools, group mappings, certificate authorities, certificate identity pools.
- [API Keys (iam/v2)](https://docs.confluent.io/cloud/current/api-keys-iam-v-2.md)
- [Users (iam/v2)](https://docs.confluent.io/cloud/current/users-iam-v-2.md)
- [Service Accounts (iam/v2)](https://docs.confluent.io/cloud/current/service-accounts-iam-v-2.md)
- [Invitations (iam/v2)](https://docs.confluent.io/cloud/current/invitations-iam-v-2.md)
- [IP Groups (iam/v2)](https://docs.confluent.io/cloud/current/ip-groups-iam-v-2.md)
- [IP Filters (iam/v2)](https://docs.confluent.io/cloud/current/ip-filters-iam-v-2.md)
- [IP Filter Summaries (iam/v2)](https://docs.confluent.io/cloud/current/ip-filter-summaries-iam-v-2.md)
- [Role Bindings (iam/v2)](https://docs.confluent.io/cloud/current/role-bindings-iam-v-2.md)
- [Identity Providers (iam/v2)](https://docs.confluent.io/cloud/current/identity-providers-iam-v-2.md)
- [Jwks (iam/v2)](https://docs.confluent.io/cloud/current/jwks-iam-v-2.md)
- [Identity Pools (iam/v2)](https://docs.confluent.io/cloud/current/identity-pools-iam-v-2.md)
- [Group Mappings (iam/v2/sso)](https://docs.confluent.io/cloud/current/group-mappings-iam-v-2-sso.md)
- [Certificate Authorities (iam/v2)](https://docs.confluent.io/cloud/current/certificate-authorities-iam-v-2.md)
- [Certificate Identity Pools (iam/v2)](https://docs.confluent.io/cloud/current/certificate-identity-pools-iam-v-2.md)

### Org API (v2)
Environments, organizations.
- [Environments (org/v2)](https://docs.confluent.io/cloud/current/environments-org-v-2.md)
- [Organizations (org/v2)](https://docs.confluent.io/cloud/current/organizations-org-v-2.md)

### Notifications API (v1)
Subscriptions, integrations, notification types, resource preferences, resource subscriptions.
- [Subscriptions (notifications/v1)](https://docs.confluent.io/cloud/current/subscriptions-notifications-v-1.md)
- [Integrations (notifications/v1)](https://docs.confluent.io/cloud/current/integrations-notifications-v-1.md)
- [Notification Types (notifications/v1)](https://docs.confluent.io/cloud/current/notification-types-notifications-v-1.md)
- [Resource Preferences (notifications/v1)](https://docs.confluent.io/cloud/current/resource-preferences-notifications-v-1.md)
- [Resource Subscriptions (notifications/v1)](https://docs.confluent.io/cloud/current/resource-subscriptions-notifications-v-1.md)

### Cluster Mgmt for Kafka (v2)
Clusters.
- [Clusters (cmk/v2)](https://docs.confluent.io/cloud/current/clusters-cmk-v-2.md)

### Cluster Mgmt for ksqlDB (v2)
Clusters.
- [Clusters (ksqldbcm/v2)](https://docs.confluent.io/cloud/current/clusters-ksqldbcm-v-2.md)

### Connect API (v1)
Connectors, lifecycle, status, managed connector plugins, offsets, custom connector plugins, presigned urls, custom connector runtimes.
- [Connectors (connect/v1)](https://docs.confluent.io/cloud/current/connectors-connect-v-1.md)
- [Lifecycle (connect/v1)](https://docs.confluent.io/cloud/current/lifecycle-connect-v-1.md)
- [Status (connect/v1)](https://docs.confluent.io/cloud/current/status-connect-v-1.md)
- [Managed Connector Plugins (connect/v1)](https://docs.confluent.io/cloud/current/managed-connector-plugins-connect-v-1.md)
- [Offsets (connect/v1)](https://docs.confluent.io/cloud/current/offsets-connect-v-1.md)
- [Custom Connector Plugins (connect/v1)](https://docs.confluent.io/cloud/current/custom-connector-plugins-connect-v-1.md)
- [Presigned Urls (connect/v1)](https://docs.confluent.io/cloud/current/presigned-urls-connect-v-1.md)
- [Custom Connector Runtimes (connect/v1)](https://docs.confluent.io/cloud/current/custom-connector-runtimes-connect-v-1.md)

### Kafka API (v3)
Cluster, configs, ACL, consumer group, partition, topic, records, cluster linking, share group, streams group.
- [Cluster (v3)](https://docs.confluent.io/cloud/current/cluster-v-3.md)
- [Configs (v3)](https://docs.confluent.io/cloud/current/configs-v-3.md)
- [ACL (v3)](https://docs.confluent.io/cloud/current/acl-v-3.md)
- [Consumer Group (v3)](https://docs.confluent.io/cloud/current/consumer-group-v-3.md)
- [Partition (v3)](https://docs.confluent.io/cloud/current/partition-v-3.md)
- [Topic (v3)](https://docs.confluent.io/cloud/current/topic-v-3.md)
- [Records (v3)](https://docs.confluent.io/cloud/current/records-v-3.md)
- [Cluster Linking (v3)](https://docs.confluent.io/cloud/current/cluster-linking-v-3.md)
- [Share Group (v3)](https://docs.confluent.io/cloud/current/share-group-v-3.md)
- [Streams Group (v3)](https://docs.confluent.io/cloud/current/streams-group-v-3.md)

### Service Quota API (v1)
Applied quotas, scopes.
- [Applied Quotas (service-quota/v1)](https://docs.confluent.io/cloud/current/applied-quotas-service-quota-v-1.md)
- [Scopes (service-quota/v1)](https://docs.confluent.io/cloud/current/scopes-service-quota-v-1.md)

### Partner API (v2)
Entitlements, organizations, signup.
- [Entitlements (partner/v2)](https://docs.confluent.io/cloud/current/entitlements-partner-v-2.md)
- [Organizations (partner/v2)](https://docs.confluent.io/cloud/current/organizations-partner-v-2.md)
- [Signup (partner/v2)](https://docs.confluent.io/cloud/current/signup-partner-v-2.md)

### Cluster Mgmt for Schema Registry (v2)
Regions, clusters.
- [Regions (srcm/v2)](https://docs.confluent.io/cloud/current/regions-srcm-v-2.md)
- [Clusters (srcm/v2)](https://docs.confluent.io/cloud/current/clusters-srcm-v-2.md)

### Cluster Mgmt for Schema Registry (v3)
Clusters.
- [Clusters (srcm/v3)](https://docs.confluent.io/cloud/current/clusters-srcm-v-3.md)

### Schema Registry API (v1)
Compatibility, config, contexts, exporters, modes, schemas, subjects, key encryption keys, data encryption keys.
- [Compatibility (v1)](https://docs.confluent.io/cloud/current/compatibility-v-1.md)
- [Config (v1)](https://docs.confluent.io/cloud/current/config-v-1.md)
- [Contexts (v1)](https://docs.confluent.io/cloud/current/contexts-v-1.md)
- [Exporters (v1)](https://docs.confluent.io/cloud/current/exporters-v-1.md)
- [Modes (v1)](https://docs.confluent.io/cloud/current/modes-v-1.md)
- [Schemas (v1)](https://docs.confluent.io/cloud/current/schemas-v-1.md)
- [Subjects (v1)](https://docs.confluent.io/cloud/current/subjects-v-1.md)
- [Key Encryption Keys (v1)](https://docs.confluent.io/cloud/current/key-encryption-keys-v-1.md)
- [Data Encryption Keys (v1)](https://docs.confluent.io/cloud/current/data-encryption-keys-v-1.md)

### Catalog API (v1)
Entity, search, types.
- [Entity (v1)](https://docs.confluent.io/cloud/current/entity-v-1.md)
- [Search (v1)](https://docs.confluent.io/cloud/current/search-v-1.md)
- [Types (v1)](https://docs.confluent.io/cloud/current/types-v-1.md)

### Stream Sharing API (v1)
Provider shared resources, provider shares, consumer shared resources, consumer shares, shared tokens, opt ins.
- [Provider Shared Resources (cdx/v1)](https://docs.confluent.io/cloud/current/provider-shared-resources-cdx-v-1.md)
- [Provider Shares (cdx/v1)](https://docs.confluent.io/cloud/current/provider-shares-cdx-v-1.md)
- [Consumer Shared Resources (cdx/v1)](https://docs.confluent.io/cloud/current/consumer-shared-resources-cdx-v-1.md)
- [Consumer Shares (cdx/v1)](https://docs.confluent.io/cloud/current/consumer-shares-cdx-v-1.md)
- [Shared Tokens (cdx/v1)](https://docs.confluent.io/cloud/current/shared-tokens-cdx-v-1.md)
- [Opt Ins (cdx/v1)](https://docs.confluent.io/cloud/current/opt-ins-cdx-v-1.md)

### Networking (v1)
Networks, peerings, transit gateway attachments, private link accesses, network link services, network link endpoints, network link service associations, IP addresses, private link attachments, private link attachment connections, DNS forwarders, access points, DNS records, gateways.
- [Networks (networking/v1)](https://docs.confluent.io/cloud/current/networks-networking-v-1.md)
- [Peerings (networking/v1)](https://docs.confluent.io/cloud/current/peerings-networking-v-1.md)
- [Transit Gateway Attachments (networking/v1)](https://docs.confluent.io/cloud/current/transit-gateway-attachments-networking-v-1.md)
- [Private Link Accesses (networking/v1)](https://docs.confluent.io/cloud/current/private-link-accesses-networking-v-1.md)
- [Network Link Services (networking/v1)](https://docs.confluent.io/cloud/current/network-link-services-networking-v-1.md)
- [Network Link Endpoints (networking/v1)](https://docs.confluent.io/cloud/current/network-link-endpoints-networking-v-1.md)
- [Network Link Service Associations (networking/v1)](https://docs.confluent.io/cloud/current/network-link-service-associations-networking-v-1.md)
- [IP Addresses (networking/v1)](https://docs.confluent.io/cloud/current/ip-addresses-networking-v-1.md)
- [Private Link Attachments (networking/v1)](https://docs.confluent.io/cloud/current/private-link-attachments-networking-v-1.md)
- [Private Link Attachment Connections (networking/v1)](https://docs.confluent.io/cloud/current/private-link-attachment-connections-networking-v-1.md)
- [DNS Forwarders (networking/v1)](https://docs.confluent.io/cloud/current/dns-forwarders-networking-v-1.md)
- [Access Points (networking/v1)](https://docs.confluent.io/cloud/current/access-points-networking-v-1.md)
- [DNS Records (networking/v1)](https://docs.confluent.io/cloud/current/dns-records-networking-v-1.md)
- [Gateways (networking/v1)](https://docs.confluent.io/cloud/current/gateways-networking-v-1.md)

### Security Token Service (v1)
OAuth tokens.
- [OAuth Tokens (sts/v1)](https://docs.confluent.io/cloud/current/o-auth-tokens-sts-v-1.md)

### Kafka Quota (v1)
Client quotas.
- [Client Quotas (kafka-quotas/v1)](https://docs.confluent.io/cloud/current/client-quotas-kafka-quotas-v-1.md)

### Bring Your Own Key (BYOK) Management (v1)
Keys.
- [Keys (byok/v1)](https://docs.confluent.io/cloud/current/keys-byok-v-1.md)

### Billing API (v1)
Costs.
- [Costs (billing/v1)](https://docs.confluent.io/cloud/current/costs-billing-v-1.md)

### Compute Pool Mgmt for Flink (v2)
Compute pools, regions, org compute pool configs.
- [Compute Pools (fcpm/v2)](https://docs.confluent.io/cloud/current/compute-pools-fcpm-v-2.md)
- [Regions (fcpm/v2)](https://docs.confluent.io/cloud/current/regions-fcpm-v-2.md)
- [Org Compute Pool Configs (fcpm/v2)](https://docs.confluent.io/cloud/current/org-compute-pool-configs-fcpm-v-2.md)

### SQL API (v1)
Statements, statement results, statement exceptions, connections, agents, tools, materialized tables, materialized table versions.
- [Statements (sql/v1)](https://docs.confluent.io/cloud/current/statements-sql-v-1.md)
- [Statement Results (sql/v1)](https://docs.confluent.io/cloud/current/statement-results-sql-v-1.md)
- [Statement Exceptions (sql/v1)](https://docs.confluent.io/cloud/current/statement-exceptions-sql-v-1.md)
- [Connections (sql/v1)](https://docs.confluent.io/cloud/current/connections-sql-v-1.md)
- [Agents (sql/v1)](https://docs.confluent.io/cloud/current/agents-sql-v-1.md)
- [Tools (sql/v1)](https://docs.confluent.io/cloud/current/tools-sql-v-1.md)
- [Materialized Tables (sql/v1)](https://docs.confluent.io/cloud/current/materialized-tables-sql-v-1.md)
- [Materialized Table Versions (sql/v1)](https://docs.confluent.io/cloud/current/materialized-table-versions-sql-v-1.md)

### Provider Integration Management (v1)
Integrations.
- [Integrations (pim/v1)](https://docs.confluent.io/cloud/current/integrations-pim-v-1.md)

### Provider Integration Management (v2)
Integrations.
- [Integrations (pim/v2)](https://docs.confluent.io/cloud/current/integrations-pim-v-2.md)

### Artifact API (v1)
Flink artifacts, presigned urls, flink artifact versions.
- [Flink Artifacts (artifact/v1)](https://docs.confluent.io/cloud/current/flink-artifacts-artifact-v-1.md)
- [Presigned Urls (artifact/v1)](https://docs.confluent.io/cloud/current/presigned-urls-artifact-v-1.md)

### Custom Code Logging API (v1)
Custom code loggings.
- [Custom Code Loggings (ccl/v1)](https://docs.confluent.io/cloud/current/custom-code-loggings-ccl-v-1.md)

### Tableflow (v1)
Regions, tableflow topics, catalog integrations.
- [Regions (tableflow/v1)](https://docs.confluent.io/cloud/current/regions-tableflow-v-1.md)
- [Tableflow Topics (tableflow/v1)](https://docs.confluent.io/cloud/current/tableflow-topics-tableflow-v-1.md)
- [Catalog Integrations (tableflow/v1)](https://docs.confluent.io/cloud/current/catalog-integrations-tableflow-v-1.md)

### Custom Connect Plugin Management (v1)
Custom connect plugins, presigned urls, custom connect plugin versions.
- [Custom Connect Plugins (ccpm/v1)](https://docs.confluent.io/cloud/current/custom-connect-plugins-ccpm-v-1.md)
- [Presigned Urls (ccpm/v1)](https://docs.confluent.io/cloud/current/presigned-urls-ccpm-v-1.md)
- [Custom Connect Plugin Versions (ccpm/v1)](https://docs.confluent.io/cloud/current/custom-connect-plugin-versions-ccpm-v-1.md)

### Unified Stream Manager (v1)
Kafka clusters, connect clusters.
- [Kafka Clusters (usm/v1)](https://docs.confluent.io/cloud/current/kafka-clusters-usm-v-1.md)
- [Connect Clusters (usm/v1)](https://docs.confluent.io/cloud/current/connect-clusters-usm-v-1.md)

### Endpoint (v1)
Endpoints.
- [Endpoints (endpoint/v1)](https://docs.confluent.io/cloud/current/endpoints-endpoint-v-1.md)

## Conventions

- **Confluent Resource Names (CRNs)**: Hierarchical resource identifiers, e.g. `crn://confluent.cloud/organization=abc/environment=env-123/cloud-cluster=lkc-456`. Used in `metadata.resource_name` fields.
- **API Lifecycle Stages**: Every endpoint has `x-lifecycle-stage`:
  - **Early Access** – May change at any time. Not recommended for production. Not officially supported. Intended for user feedback only. Users must be granted explicit access by Confluent.
  - **Preview** – Unlikely to change before GA. Not recommended for production. Officially supported for non-production. Accessible to all users.
  - **Limited Availability (LA)** – Available to select customers in a subset of regions/providers/networks. Recommended for production.
  - **Generally Available (GA)** – Will not change at short notice. Recommended for production. Officially supported for non-production and production.
  - **Deprecated** – Still supported but no longer under active development. Migration following the upgrade guide is strongly recommended. Will be removed at the announced date.
  - **Sunset** – Removed, no longer supported or available.
- **Pagination**: List endpoints return `metadata.next` URL for cursor-based pagination. Use `page_size` query param to control page size (default 10, max 100).
- **Error responses**: RFC 9457 Problem Details, with possible Confluent-specific `errors[]` extensions such as `errors[].id`, `errors[].status`, `errors[].detail`, and `errors[].source`.
- **readOnly fields**: Fields like `id`, `metadata`, `api_version`, `kind` are read-only — omit them from POST/PATCH request bodies.
- **x-immutable fields**: Fields like `cloud`, `region` can be set at creation (POST) but not changed (PATCH).
- **Object references**: Related resources are referenced via `ObjectReference` objects containing `id`, `related` (URL), and `resource_name` (CRN).

## Related tools

- [Terraform Provider for Confluent](https://registry.terraform.io/providers/confluentinc/confluent/latest/docs): Infrastructure-as-code for all Confluent Cloud resources.
- [Confluent CLI](https://docs.confluent.io/confluent-cli/current/overview.html): Command-line interface for managing Confluent Cloud.
- [Confluent Cloud Console](https://confluent.cloud): Web UI for managing Confluent Cloud.
- [Confluent Documentation](https://docs.confluent.io/): Full documentation including guides, tutorials, and reference.
- [Confluent Cloud Status](https://status.confluent.cloud/): Service health and incident history.