Confluent Cloud REST API
The Confluent Cloud REST API is the management plane for Confluent Cloud. It is used to manage organizations, environments, Kafka and Flink clusters, service accounts, API keys, role bindings, networking, schema registry clusters, and connector instances. The API uses Cloud API keys for authentication and follows Confluent's resource-oriented v2 conventions.
| Confluent Cloud REST API is one of 11 APIs that [Confluent | the Data Streaming Platform](https://apis.io/providers/confluent-the-data-streaming-platform/) publishes on the APIs.io network, described by a machine-readable OpenAPI specification. |
Tagged areas include Confluent Cloud, Management, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes 504 operations across 299 paths, organized into 116 resource areas, and defines 624 schemas. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://api.confluent.cloud.
504 operations
299 paths
624 schemas
78 DELETE244 GET48 PATCH103 POST31 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 6
Confluent Cloud REST 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 504
Across 299 paths, the API surfaces 504 operations — 78 DELETE, 244 GET, 48 PATCH, 103 POST, 31 PUT. They span 116 resource areas, including API Keys (iam/v2), Environments (org/v2), Organizations (org/v2), Users (iam/v2), Service Accounts (iam/v2), Invitations (iam/v2), IP Groups (iam/v2), IP Filters (iam/v2), and 108 more. Each is listed below with its method, path, parameters, and response codes.
API Keys (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) ApiKey objects represent access…
GET
/iam/v2/api-keys
List of API Keys
POST
/iam/v2/api-keys
Create an API Key
GET
/iam/v2/api-keys/{id}
Read an API Key
PATCH
/iam/v2/api-keys/{id}
Update an API Key
DELETE
/iam/v2/api-keys/{id}
Delete an API Key
Environments (org/v2) 5
[](section/Versioning/API-Lifecycle-Policy) Environment objects represent a…
GET
/org/v2/environments
List of Environments
POST
/org/v2/environments
Create an Environment
GET
/org/v2/environments/{id}
Read an Environment
PATCH
/org/v2/environments/{id}
Update an Environment
DELETE
/org/v2/environments/{id}
Delete an Environment
Organizations (org/v2) 3
[](section/Versioning/API-Lifecycle-Policy) Organization objects represent…
GET
/org/v2/organizations
List of Organizations
GET
/org/v2/organizations/{id}
Read an Organization
PATCH
/org/v2/organizations/{id}
Update an Organization
Users (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) User objects represent individu…
GET
/iam/v2/users
List of Users
GET
/iam/v2/users/{id}
Read a User
PATCH
/iam/v2/users/{id}
Update a User
DELETE
/iam/v2/users/{id}
Delete a User
PATCH
/iam/v2/users/{id}/auth
Update Auth Type of a User
Service Accounts (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) ServiceAccount objects are typi…
GET
/iam/v2/service-accounts
List of Service Accounts
POST
/iam/v2/service-accounts
Create a Service Account
GET
/iam/v2/service-accounts/{id}
Read a Service Account
PATCH
/iam/v2/service-accounts/{id}
Update a Service Account
DELETE
/iam/v2/service-accounts/{id}
Delete a Service Account
Invitations (iam/v2) 4
[](section/Versioning/API-Lifecycle-Policy) Invitation objects represent in…
GET
/iam/v2/invitations
List of Invitations
POST
/iam/v2/invitations
Create an Invitation
GET
/iam/v2/invitations/{id}
Read an Invitation
DELETE
/iam/v2/invitations/{id}
Delete an Invitation
IP Groups (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) Definitions of networks which c…
GET
/iam/v2/ip-groups
List of IP Groups
POST
/iam/v2/ip-groups
Create an IP Group
GET
/iam/v2/ip-groups/{id}
Read an IP Group
PATCH
/iam/v2/ip-groups/{id}
Update an IP Group
DELETE
/iam/v2/ip-groups/{id}
Delete an IP Group
IP Filters (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) IP Filter objects are bindings…
GET
/iam/v2/ip-filters
List of IP Filters
POST
/iam/v2/ip-filters
Create an IP Filter
GET
/iam/v2/ip-filters/{id}
Read an IP Filter
PATCH
/iam/v2/ip-filters/{id}
Update an IP Filter
DELETE
/iam/v2/ip-filters/{id}
Delete an IP Filter
IP Filter Summaries (iam/v2) 1
[](section/Versioning/API-Lifecycle-Policy) The IP Filter Summary endpoint…
GET
/iam/v2/ip-filter-summary
Read an IP Filter Summary
Role Bindings (iam/v2) 4
[](section/Versioning/API-Lifecycle-Policy) A role binding grants a Princip…
GET
/iam/v2/role-bindings
List of Role Bindings
POST
/iam/v2/role-bindings
Create a Role Binding
GET
/iam/v2/role-bindings/{id}
Read a Role Binding
DELETE
/iam/v2/role-bindings/{id}
Delete a Role Binding
Subscriptions (notifications/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Subscription objects represent…
GET
/notifications/v1/subscriptions
List of Subscriptions
POST
/notifications/v1/subscriptions
Create a Subscription
GET
/notifications/v1/subscriptions/{id}
Read a Subscription
PATCH
/notifications/v1/subscriptions/{id}
Update a Subscription
DELETE
/notifications/v1/subscriptions/{id}
Delete a Subscription
Integrations (notifications/v1) 6
[](section/Versioning/API-Lifecycle-Policy) You can create an Integration t…
POST
/notifications/v1/integrations
Create an Integration
GET
/notifications/v1/integrations
Retrieve a list of integrations. Optionally filter by resource and resource type.
GET
/notifications/v1/integrations/{id}
Read an Integration
PATCH
/notifications/v1/integrations/{id}
Update an Integration
DELETE
/notifications/v1/integrations/{id}
Delete an Integration
POST
/notifications/v1/integrations:test
Test a Webhook, Slack or Microsoft Teams integration
Notification Types (notifications/v1) 2
[](section/Versioning/API-Lifecycle-Policy) The type of notifications (and…
GET
/notifications/v1/notification-types/{id}
Read a Notification Type
GET
/notifications/v1/notification-types
Retrieve a list of all notification types for the resource type.
Resource Preferences (notifications/v1) 5
[](section/Versioning/API-Lifecycle-Policy) ResourcePreference objects repr…
POST
/notifications/v1/resource-preferences
Create a Resource Preference
GET
/notifications/v1/resource-preferences/{id}
Read a Resource Preference
PATCH
/notifications/v1/resource-preferences/{id}
Update a Resource Preference
DELETE
/notifications/v1/resource-preferences/{id}
Delete a Resource Preference
GET
/notifications/v1/resource-preferences:lookup
Lookup a resource preference by filter (returns one)
Resource Subscriptions (notifications/v1) 5
[](section/Versioning/API-Lifecycle-Policy) ResourceSubscription objects re…
POST
/notifications/v1/resource-subscriptions
Create a Resource Subscription
GET
/notifications/v1/resource-subscriptions/{id}
Read a Resource Subscription
PATCH
/notifications/v1/resource-subscriptions/{id}
Update a Resource Subscription
DELETE
/notifications/v1/resource-subscriptions/{id}
Delete a Resource Subscription
GET
/notifications/v1/resource-subscriptions:lookup
Lookup a list of resource subscription by filter
User Notifications (notifications/v1) 5
[](section/Versioning/API-Lifecycle-Policy) [![Request Access To User Notifications API v1]…
GET
/notifications/v1/user-notifications
List of User Notifications
GET
/notifications/v1/user-notifications/{id}
Read a User Notification
PATCH
/notifications/v1/user-notifications/{id}
Update a User Notification
PATCH
/notifications/v1/user-notifications:mark-all
Mark multiple notifications read or unread
GET
/notifications/v1/user-notifications:summary
Get notification summary
Clusters (cmk/v2) 5
[](section/Versioning/API-Lifecycle-Policy) Clusters objects represent Apac…
GET
/cmk/v2/clusters
List of Clusters
POST
/cmk/v2/clusters
Create a Cluster
GET
/cmk/v2/clusters/{id}
Read a Cluster
PATCH
/cmk/v2/clusters/{id}
Update a Cluster
DELETE
/cmk/v2/clusters/{id}
Delete a Cluster
Clusters (ksqldbcm/v2) 4
[](section/Versioning/API-Lifecycle-Policy) Cluster represents a ksqlDB run…
GET
/ksqldbcm/v2/clusters
List of Clusters
POST
/ksqldbcm/v2/clusters
Create a Cluster
GET
/ksqldbcm/v2/clusters/{id}
Read a Cluster
DELETE
/ksqldbcm/v2/clusters/{id}
Delete a Cluster
Connectors (connect/v1) 7
[](section/Versioning/API-Lifecycle-Policy) API for Managed Connectors or C…
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors
List of Connectors
POST
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors
Create a Connector
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id
List of Connectors with Expansions
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config
Read a Connector Configuration
PUT
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config
Create or Update a Connector Configuration
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}
Read a Connector
DELETE
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}
Delete a Connector
Lifecycle (connect/v1) 3
[](section/Versioning/API-Lifecycle-Policy) API for managing the lifecycle…
PUT
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/pause
Pause a Connector
PUT
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/resume
Resume a Connector
POST
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/restart
Restart a Connector
Status (connect/v1) 2
[](section/Versioning/API-Lifecycle-Policy) API for requesting the status o…
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/status
Read a Connector Status
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/tasks
List of Connector Tasks
Managed Connector Plugins (connect/v1) 3
[](section/Versioning/API-Lifecycle-Policy) API for Managed connectors in C…
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins
List of Managed Connector plugins
PUT
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/validate
Validate a Managed Connector Plugin
PUT
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connector-plugins/{plugin_name}/config/translate?mask_sensitive=true
Translate Self Managed Connector Plugin Configurations to Fully Managed Connector Plugin Configurations
Offsets (connect/v1) 3
[](section/Versioning/API-Lifecycle-Policy) API for managing the offsets fo…
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets
Get a Connector Offsets
POST
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request
Request to Alter the Connector Offsets
GET
/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status
Get the Status of Alter Offset Request
Connect Artifacts (cam/v1) 4
[](section/Versioning/API-Lifecycle-Policy) Connect Artifact objects repres…
GET
/cam/v1/connect-artifacts
List of Connect Artifacts
POST
/cam/v1/connect-artifacts
Create a new Connect Artifact.
GET
/cam/v1/connect-artifacts/{id}
Read a Connect Artifact
DELETE
/cam/v1/connect-artifacts/{id}
Delete a Connect Artifact
Presigned Urls (cam/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Request a presigned upload URL…
POST
/cam/v1/presigned-upload-url
Request a presigned upload URL for a new Connect Artifact.
Custom Connector Plugins (connect/v1) 5
[](section/Versioning/API-Lifecycle-Policy) CustomConnectorPlugins objects…
GET
/connect/v1/custom-connector-plugins
List of Custom Connector Plugins
POST
/connect/v1/custom-connector-plugins
Create a Custom Connector Plugin
GET
/connect/v1/custom-connector-plugins/{id}
Read a Custom Connector Plugin
PATCH
/connect/v1/custom-connector-plugins/{id}
Update a Custom Connector Plugin
DELETE
/connect/v1/custom-connector-plugins/{id}
Delete a Custom Connector Plugin
Presigned Urls (connect/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Request a presigned upload URL…
POST
/connect/v1/presigned-upload-url
Request a presigned upload URL for a new Custom Connector Plugin.
Custom Connector Runtimes (connect/v1) 1
[](section/Versioning/API-Lifecycle-Policy) List of supported runtime langu…
GET
/connect/v1/custom-connector-runtimes
List of Custom Connector Runtimes
Cluster (v3) 1
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}
Get Cluster
ACL (v3) 4
[](section/Versioning/API-Lifecycle-Policy)
POST
/kafka/v3/clusters/{cluster_id}/acls:batch
Batch Create ACLs
GET
/kafka/v3/clusters/{cluster_id}/acls
List ACLs
POST
/kafka/v3/clusters/{cluster_id}/acls
Create an ACL
DELETE
/kafka/v3/clusters/{cluster_id}/acls
Delete ACLs
Configs (v3) 17
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/broker-configs
List Dynamic Broker Configs
POST
/kafka/v3/clusters/{cluster_id}/broker-configs:alter
Batch Alter Dynamic Broker Configs
GET
/kafka/v3/clusters/{cluster_id}/broker-configs/{name}
Get Dynamic Broker Config
PUT
/kafka/v3/clusters/{cluster_id}/broker-configs/{name}
Update Dynamic Broker Config
DELETE
/kafka/v3/clusters/{cluster_id}/broker-configs/{name}
Reset Dynamic Broker Config
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs
List Topic Configs
POST
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter
Batch Alter Topic Configs
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}
Get Topic Config
PUT
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}
Update Topic Config
DELETE
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}
Reset Topic Config
GET
/kafka/v3/clusters/{cluster_id}/topics/-/configs
List All Topic Configs
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs
List New Topic Default Configs
GET
/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs
List all configs of the group
GET
/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}
Get group config
PUT
/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}
Update group config
DELETE
/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}
Delete group config
POST
/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter
Batch Alter Group Configs
Consumer Group (v3) 7
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups
List Consumer Groups
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}
Get Consumer Group
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers
List Consumers
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary
Get Consumer Group Lag Summary
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags
List Consumer Lags
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}
Get Consumer Lag
GET
/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}
Get Consumer
Topic (v3) 5
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/topics
List Topics
POST
/kafka/v3/clusters/{cluster_id}/topics
Create Topic
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}
Get Topic
PATCH
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}
Update Partition Count
DELETE
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}
Delete Topic
Partition (v3) 2
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions
List Partitions
GET
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}
Get Partition
Records (v3) 1
[](section/Versioning/API-Lifecycle-Policy)
POST
/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records
Produce Records
Cluster Linking (v3) 20
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/links
List all cluster links in the dest cluster
POST
/kafka/v3/clusters/{cluster_id}/links
Create a cluster link
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}
Describe the cluster link
DELETE
/kafka/v3/clusters/{cluster_id}/links/{link_name}
Delete the cluster link
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs
List all configs of the cluster link
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Describe the config under the cluster link
PUT
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Alter the config under the cluster link
DELETE
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs/{config_name}
Reset the given config to default value
PUT
/kafka/v3/clusters/{cluster_id}/links/{link_name}/configs:alter
Batch Alter Cluster Link Configs
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors
Create a mirror topic
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors
List mirror topics
GET
/kafka/v3/clusters/{cluster_id}/links/-/mirrors
List mirror topics
GET
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors/{mirror_topic_name}
Describe the mirror topic
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:promote
Promote the mirror topics
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:failover
Failover the mirror topics
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:pause
Pause the mirror topics
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:resume
Resume the mirror topics
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-start-mirror
Reverse the local mirror topic and start the remote mirror topic
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:reverse-and-pause-mirror
Reverse the local mirror topic and Pause the remote mirror topic
POST
/kafka/v3/clusters/{cluster_id}/links/{link_name}/mirrors:truncate-and-restore
Truncates the local topic to the remote stopped mirror log end offsets and restores mirroring to the local topic to mirror from the remote topic
Share Group (v3) 6
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/share-groups
List Share Groups
GET
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}
Get Share Group
DELETE
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}
Delete Share Group
GET
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers
List Share Group Consumers
GET
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}
Get Share Group Consumer
GET
/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments
List Share Group Consumer Assignments
Streams Group (v3) 12
[](section/Versioning/API-Lifecycle-Policy)
GET
/kafka/v3/clusters/{cluster_id}/streams-groups
List Streams Groups
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}
Get Streams Group
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies
List Streams Group Subtopologies
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/subtopologies/{subtopology_id}
Get Streams Group Subtopology
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members
List Streams Group Members
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}
Get Streams Group Member
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments
Get Streams Group Member Assignments
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments
Get Streams Group Member Target Assignments
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}
List Streams Group Assignments of a Specific Type
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}
List Streams Group Target Assignments of a Specific Type
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}
List Streams Group Assignments Task Partitions of a Specific Type and Subtopology
GET
/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}
List Streams Group Target Assignments Task Partitions of a Specific Type and Subtopology
Applied Quotas (service-quota/v1) 2
[](section/Versioning/API-Lifecycle-Policy) A quota object represents a quo…
GET
/service-quota/v1/applied-quotas
List of Applied Quotas
GET
/service-quota/v1/applied-quotas/{id}
Read an Applied Quota
Scopes (service-quota/v1) 2
[](section/Versioning/API-Lifecycle-Policy) Gets a list of all available sc…
GET
/service-quota/v1/scopes
List of Scopes
GET
/service-quota/v1/scopes/{id}
Read a Scope
Entitlements (partner/v2) 3
[](section/Versioning/API-Lifecycle-Policy) [ 2
[](section/Versioning/API-Lifecycle-Policy) Region objects represent cloud provider regions avail…
GET
/srcm/v2/regionsdeprecated
List of Regions
GET
/srcm/v2/regions/{id}deprecated
Read a Region
Clusters (srcm/v2) 5
[](section/Versioning/API-Lifecycle-Policy) Clusters objects represent Schema Registry Clusters o…
GET
/srcm/v2/clustersdeprecated
List of Clusters
POST
/srcm/v2/clustersdeprecated
Create a Cluster
GET
/srcm/v2/clusters/{id}deprecated
Read a Cluster
PATCH
/srcm/v2/clusters/{id}deprecated
Update a Cluster
DELETE
/srcm/v2/clusters/{id}deprecated
Delete a Cluster
Clusters (srcm/v3) 2
[](section/Versioning/API-Lifecycle-Policy) Clusters objects represent Sche…
GET
/srcm/v3/clusters
List of Clusters
GET
/srcm/v3/clusters/{id}
Read a Cluster
Config (v1) 7
[](section/Versioning/API-Lifecycle-Policy) The API allows you to manage and…
GET
/clusterconfig
Get cluster config
GET
/config/{subject}
Get subject compatibility level
PUT
/config/{subject}
Update subject compatibility level
DELETE
/config/{subject}
Delete subject compatibility level
GET
/config
Get global compatibility level
PUT
/config
Update global compatibility level
DELETE
/config
Delete global compatibility level
Compatibility (v1) 2
[](section/Versioning/API-Lifecycle-Policy) The API allows you to test schema…
POST
/compatibility/subjects/{subject}/versions/{version}
Test schema compatibility against a particular schema subject-version
POST
/compatibility/subjects/{subject}/versions
Test schema compatibility against all schemas under a subject
Exporters (v1) 11
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/exporters
Gets all schema exporters
POST
/exporters
Creates a new schema exporter
GET
/exporters/{name}
Gets schema exporter by name
PUT
/exporters/{name}
Update schema exporter by name
DELETE
/exporters/{name}
Delete schema exporter by name
GET
/exporters/{name}/status
Gets schema exporter status by name
GET
/exporters/{name}/config
Gets schema exporter config by name
PUT
/exporters/{name}/config
Update schema exporter config by name
PUT
/exporters/{name}/pause
Pause schema exporter by name
PUT
/exporters/{name}/reset
Reset schema exporter by name
PUT
/exporters/{name}/resume
Resume schema exporter by name
Contexts (v1) 1
[](section/Versioning/API-Lifecycle-Policy) The API allows you to retrieve in…
GET
/contexts
List contexts
Modes (v1) 5
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/mode/{subject}
Get subject mode
PUT
/mode/{subject}
Update subject mode
DELETE
/mode/{subject}
Delete subject mode
GET
/mode
Get global mode
PUT
/mode
Update global mode
Schemas (v1) 6
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/schemas/ids/{id}
Get schema string by ID
GET
/schemas/ids/{id}/schema
Get schema by ID
GET
/schemas/types
List supported schema types
GET
/schemas
List schemas
GET
/schemas/ids/{id}/subjects
List subjects associated to schema ID
GET
/schemas/ids/{id}/versions
List subject-versions associated to schema ID
Subjects (v1) 10
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/subjects/{subject}/versions/{version}
Get schema by version
DELETE
/subjects/{subject}/versions/{version}
Delete schema version
GET
/subjects/{subject}/versions/{version}/referencedby
List schemas referencing a schema
GET
/subjects/{subject}/versions/{version}/schema
Get schema string by version
GET
/subjects/{subject}/versions
List versions under subject
POST
/subjects/{subject}/versions
Register schema under a subject
POST
/subjects/{subject}
Lookup schema under subject
DELETE
/subjects/{subject}
Delete subject
GET
/subjects
List subjects
GET
/subjects/{subject}/metadata
Retrieve the latest version with the given metadata.
Key Encryption Keys (v1) 7
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/dek-registry/v1/keks
Get a list of kek names
POST
/dek-registry/v1/keks
Create a kek
DELETE
/dek-registry/v1/keks/{name}
Delete a kek
GET
/dek-registry/v1/keks/{name}
Get a kek by name
PUT
/dek-registry/v1/keks/{name}
Alters a kek
POST
/dek-registry/v1/keks/{name}/undelete
Undelete a kek
POST
/dek-registry/v1/keks/{name}/test
Test a kek
Data Encryption Keys (v1) 9
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/dek-registry/v1/keks/{name}/deks
Get a list of dek subjects
POST
/dek-registry/v1/keks/{name}/deks
Create a dek
DELETE
/dek-registry/v1/keks/{name}/deks/{subject}
Delete all versions of a dek
GET
/dek-registry/v1/keks/{name}/deks/{subject}
Get a dek by subject
DELETE
/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}
Delete a dek version
GET
/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}
Get a dek by subject and version
GET
/dek-registry/v1/keks/{name}/deks/{subject}/versions
List versions of dek
POST
/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete
Undelete a dek version
POST
/dek-registry/v1/keks/{name}/deks/{subject}/undelete
Undelete all versions of a dek
Types (v1) 10
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
GET
/catalog/v1/types/businessmetadatadefs
Bulk Read Business Metadata Definitions
POST
/catalog/v1/types/businessmetadatadefs
Bulk Create Business Metadata Definitions
PUT
/catalog/v1/types/businessmetadatadefs
Bulk Update Business Metadata Definitions
DELETE
/catalog/v1/types/businessmetadatadefs/{bmName}
Delete Business Metadata Definition
GET
/catalog/v1/types/businessmetadatadefs/{bmName}
Read Business Metadata Definition
GET
/catalog/v1/types/tagdefs
Bulk Read Tag Definitions
PUT
/catalog/v1/types/tagdefs
Bulk Update Tag Definitions
POST
/catalog/v1/types/tagdefs
Bulk Create Tag Definitions
GET
/catalog/v1/types/tagdefs/{tagName}
Read Tag Definition
DELETE
/catalog/v1/types/tagdefs/{tagName}
Delete Tag Definition
Entity (v1) 10
[](section/Versioning/API-Lifecycle-Policy) The API allows you to create, ret…
POST
/catalog/v1/entity/businessmetadata
Bulk Create Business Metadata
PUT
/catalog/v1/entity/businessmetadata
Bulk Update Business Metadata
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata
Read Business Metadata for an Entity
DELETE
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/businessmetadata/{bmName}
Delete a Business Metadata for an Entity
PUT
/catalog/v1/entity/tags
Bulk Update Tags
POST
/catalog/v1/entity/tags
Bulk Create Tags
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}
Read an Entity
GET
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags
Read Tags for an Entity
PUT
/catalog/v1/entity
Update an Entity Attribute
DELETE
/catalog/v1/entity/type/{typeName}/name/{qualifiedName}/tags/{tagName}
Delete a Tag for an Entity
Search (v1) 2
[](section/Versioning/API-Lifecycle-Policy) The API allows you to search for…
GET
/catalog/v1/search/attribute
Search by Attribute
GET
/catalog/v1/search/basic
Search by Fulltext Query
Provider Shared Resources (cdx/v1) 6
[](section/Versioning/API-Lifecycle-Policy) ProviderSharedResource object c…
GET
/cdx/v1/provider-shared-resources
List of Provider Shared Resources
GET
/cdx/v1/provider-shared-resources/{id}
Read a Provider Shared Resource
PATCH
/cdx/v1/provider-shared-resources/{id}
Update a Provider Shared Resource
POST
/cdx/v1/provider-shared-resources/{id}/images/{file_name}
Upload image for shared resource
GET
/cdx/v1/provider-shared-resources/{id}/images/{file_name}
Get image for shared resource
DELETE
/cdx/v1/provider-shared-resources/{id}/images/{file_name}
Delete the shared resource's image
Provider Shares (cdx/v1) 5
[](section/Versioning/API-Lifecycle-Policy) ProviderShare object respresent…
GET
/cdx/v1/provider-shares
List of Provider Shares
POST
/cdx/v1/provider-shares
Create a provider share
GET
/cdx/v1/provider-shares/{id}
Read a Provider Share
DELETE
/cdx/v1/provider-shares/{id}
Delete a Provider Share
POST
/cdx/v1/provider-shares/{id}:resend
Resend
Consumer Shared Resources (cdx/v1) 4
[](section/Versioning/API-Lifecycle-Policy) ConsumerSharedResource object c…
GET
/cdx/v1/consumer-shared-resources
List of Consumer Shared Resources
GET
/cdx/v1/consumer-shared-resources/{id}
Read a Consumer Shared Resource
GET
/cdx/v1/consumer-shared-resources/{id}/images/{file_name}
Get image for shared resource
GET
/cdx/v1/consumer-shared-resources/{id}:network
Get shared resource's network configuration
Consumer Shares (cdx/v1) 3
[](section/Versioning/API-Lifecycle-Policy) ConsumerShare object respresent…
GET
/cdx/v1/consumer-shares
List of Consumer Shares
GET
/cdx/v1/consumer-shares/{id}
Read a Consumer Share
DELETE
/cdx/v1/consumer-shares/{id}
Delete a Consumer Share
Shared Tokens (cdx/v1) 2
[](section/Versioning/API-Lifecycle-Policy) Encrypted Token shared with con…
POST
/cdx/v1/shared-tokens:resources
Validate token to view shared resources
POST
/cdx/v1/shared-tokens:redeem
Redeem token
Opt Ins (cdx/v1) 2
[](section/Versioning/API-Lifecycle-Policy) Stream sharing opt in options T…
GET
/cdx/v1/opt-in
Read the organization's stream sharing opt-in settings
PATCH
/cdx/v1/opt-in
Set the organization's stream sharing opt-in settings
Organizations (partner/v2) 2
[](section/Versioning/API-Lifecycle-Policy) [ 3
[](section/Versioning/API-Lifecycle-Policy) [ 5
[](section/Versioning/API-Lifecycle-Policy) Network represents a network (V…
GET
/networking/v1/networks
List of Networks
POST
/networking/v1/networks
Create a Network
GET
/networking/v1/networks/{id}
Read a Network
PATCH
/networking/v1/networks/{id}
Update a Network
DELETE
/networking/v1/networks/{id}
Delete a Network
Peerings (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Add or remove VPC/VNet peering…
GET
/networking/v1/peerings
List of Peerings
POST
/networking/v1/peerings
Create a Peering
GET
/networking/v1/peerings/{id}
Read a Peering
PATCH
/networking/v1/peerings/{id}
Update a Peering
DELETE
/networking/v1/peerings/{id}
Delete a Peering
Transit Gateway Attachments (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) AWS Transit Gateway Attachments…
GET
/networking/v1/transit-gateway-attachments
List of Transit Gateway Attachments
POST
/networking/v1/transit-gateway-attachments
Create a Transit Gateway Attachment
GET
/networking/v1/transit-gateway-attachments/{id}
Read a Transit Gateway Attachment
PATCH
/networking/v1/transit-gateway-attachments/{id}
Update a Transit Gateway Attachment
DELETE
/networking/v1/transit-gateway-attachments/{id}
Delete a Transit Gateway Attachment
Private Link Accesses (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Add or remove access to Private…
GET
/networking/v1/private-link-accesses
List of Private Link Accesses
POST
/networking/v1/private-link-accesses
Create a Private Link Access
GET
/networking/v1/private-link-accesses/{id}
Read a Private Link Access
PATCH
/networking/v1/private-link-accesses/{id}
Update a Private Link Access
DELETE
/networking/v1/private-link-accesses/{id}
Delete a Private Link Access
Network Link Services (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Network Link Service is associa…
GET
/networking/v1/network-link-services
List of Network Link Services
POST
/networking/v1/network-link-services
Create a Network Link Service
GET
/networking/v1/network-link-services/{id}
Read a Network Link Service
PATCH
/networking/v1/network-link-services/{id}
Update a Network Link Service
DELETE
/networking/v1/network-link-services/{id}
Delete a Network Link Service
Network Link Endpoints (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) A Network Link Enpoint is assoc…
GET
/networking/v1/network-link-endpoints
List of Network Link Endpoints
POST
/networking/v1/network-link-endpoints
Create a Network Link Endpoint
GET
/networking/v1/network-link-endpoints/{id}
Read a Network Link Endpoint
PATCH
/networking/v1/network-link-endpoints/{id}
Update a Network Link Endpoint
DELETE
/networking/v1/network-link-endpoints/{id}
Delete a Network Link Endpoint
Network Link Service Associations (networking/v1) 2
[](section/Versioning/API-Lifecycle-Policy) List of incoming Network Link E…
GET
/networking/v1/network-link-service-associations
List of Network Link Service Associations
GET
/networking/v1/network-link-service-associations/{id}
Read a Network Link Service Association
IP Addresses (networking/v1) 1
[](section/Versioning/API-Lifecycle-Policy) IP Addresses Related guide: [Us…
GET
/networking/v1/ip-addresses
List of IP Addresses
Private Link Attachments (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) PrivateLink attachment objects…
GET
/networking/v1/private-link-attachments
List of Private Link Attachments
POST
/networking/v1/private-link-attachments
Create a Private Link Attachment
GET
/networking/v1/private-link-attachments/{id}
Read a Private Link Attachment
PATCH
/networking/v1/private-link-attachments/{id}
Update a Private Link Attachment
DELETE
/networking/v1/private-link-attachments/{id}
Delete a Private Link Attachment
Private Link Attachment Connections (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) PrivateLink attachment connecti…
GET
/networking/v1/private-link-attachment-connections
List of Private Link Attachment Connections
POST
/networking/v1/private-link-attachment-connections
Create a Private Link Attachment Connection
GET
/networking/v1/private-link-attachment-connections/{id}
Read a Private Link Attachment Connection
PATCH
/networking/v1/private-link-attachment-connections/{id}
Update a Private Link Attachment Connection
DELETE
/networking/v1/private-link-attachment-connections/{id}
Delete a Private Link Attachment Connection
Identity Providers (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) IdentityProvider objects repres…
GET
/iam/v2/identity-providers
List of Identity Providers
POST
/iam/v2/identity-providers
Create an Identity Provider
GET
/iam/v2/identity-providers/{id}
Read an Identity Provider
PATCH
/iam/v2/identity-providers/{id}
Update an Identity Provider
DELETE
/iam/v2/identity-providers/{id}
Delete an Identity Provider
Jwks (iam/v2) 1
[](section/Versioning/API-Lifecycle-Policy) JWKS objects represent public k…
PATCH
/iam/v2/identity-providers/{provider_id}/jwks
Refresh a provider's JWKS
Identity Pools (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) IdentityPool objects represent…
GET
/iam/v2/identity-providers/{provider_id}/identity-pools
List of Identity Pools
POST
/iam/v2/identity-providers/{provider_id}/identity-pools
Create an Identity Pool
GET
/iam/v2/identity-providers/{provider_id}/identity-pools/{id}
Read an Identity Pool
PATCH
/iam/v2/identity-providers/{provider_id}/identity-pools/{id}
Update an Identity Pool
DELETE
/iam/v2/identity-providers/{provider_id}/identity-pools/{id}
Delete an Identity Pool
OAuth Tokens (sts/v1) 1
[](section/Versioning/API-Lifecycle-Policy) OAuth Token is a [JSON Web Toke…
POST
/sts/v1/oauth2/token
Exchange an OAuth Token
Client Quotas (kafka-quotas/v1) 5
[](section/Versioning/API-Lifecycle-Policy) ClientQuota objects represent C…
GET
/kafka-quotas/v1/client-quotas
List of Client Quotas
POST
/kafka-quotas/v1/client-quotas
Create a Client Quota
GET
/kafka-quotas/v1/client-quotas/{id}
Read a Client Quota
PATCH
/kafka-quotas/v1/client-quotas/{id}
Update a Client Quota
DELETE
/kafka-quotas/v1/client-quotas/{id}
Delete a Client Quota
Keys (byok/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Key objects represent customer…
GET
/byok/v1/keys
List of Keys
POST
/byok/v1/keys
Create a Key
GET
/byok/v1/keys/{id}
Read a Key
PATCH
/byok/v1/keys/{id}
Update a Key
DELETE
/byok/v1/keys/{id}
Delete a Key
Costs (billing/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Cost objects represent the aggr…
GET
/billing/v1/costs
List of Costs
Group Mappings (iam/v2/sso) 5
[](section/Versioning/API-Lifecycle-Policy) GroupMapping objects establish…
GET
/iam/v2/sso/group-mappings
List of Group Mappings
POST
/iam/v2/sso/group-mappings
Create a Group Mapping
GET
/iam/v2/sso/group-mappings/{id}
Read a Group Mapping
PATCH
/iam/v2/sso/group-mappings/{id}
Update a Group Mapping
DELETE
/iam/v2/sso/group-mappings/{id}
Delete a Group Mapping
Compute Pools (fcpm/v2) 5
[](section/Versioning/API-Lifecycle-Policy) A Compute Pool represents a set…
GET
/fcpm/v2/compute-pools
List of Compute Pools
POST
/fcpm/v2/compute-pools
Create a Compute Pool
GET
/fcpm/v2/compute-pools/{id}
Read a Compute Pool
PATCH
/fcpm/v2/compute-pools/{id}
Update a Compute Pool
DELETE
/fcpm/v2/compute-pools/{id}
Delete a Compute Pool
Regions (fcpm/v2) 1
[](section/Versioning/API-Lifecycle-Policy) Region objects represent cloud…
GET
/fcpm/v2/regions
List of Regions
Org Compute Pool Configs (fcpm/v2) 2
[](section/Versioning/API-Lifecycle-Policy) OrgComputePoolConfig manages co…
GET
/fcpm/v2/compute-pool-config
Read an Org Compute Pool Config
PATCH
/fcpm/v2/compute-pool-config
Update an Org Compute Pool Config
Connections (sql/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Connection represents a core re…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections
List of Connections
POST
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections
Create a Connection
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}
Read a Connection
DELETE
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}
Delete a Connection
PUT
/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}
Update a Connection
Statement Results (sql/v1) 1
[](section/Versioning/API-Lifecycle-Policy) StatementResult represents a re…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results
Read Statement Result
Statements (sql/v1) 6
[](section/Versioning/API-Lifecycle-Policy) Statement represents a core res…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements
List of Statements
POST
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements
Create a Statement
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}
Read a Statement
DELETE
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}
Delete a Statement
PUT
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}
Update a Statement
PATCH
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}
Patch a Statement
Statement Exceptions (sql/v1) 1
[](section/Versioning/API-Lifecycle-Policy) StatementException represents a…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}/exceptions
List of Statement Exceptions
Materialized Tables (sql/v1) 5
[](section/Versioning/API-Lifecycle-Policy) MaterializedTable represents a…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables
List all materialized tables
POST
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables
Create a materialized table
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}
Read a materialized table
PUT
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}
Update/Evolve a materialized table
DELETE
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}
Delete a materialized table
Materialized Table Versions (sql/v1) 2
[](section/Versioning/API-Lifecycle-Policy) MaterializedTableVersion repres…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions
List all the versions of a materialized table
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}
Read a materialized table version
Agents (sql/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Agent models an AI agent that uses a specified model, promp…
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/agents
List all agents
POST
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents
Create an Agent
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}
Read an Agent
PUT
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}
Alter an Agent
DELETE
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/agents/{agent_name}
Delete an Agent
Tools (sql/v1) 4
[](section/Versioning/API-Lifecycle-Policy) Tool models a reusable tool resource backed by a connection…
POST
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools
Create a Tool
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools
List of Tools
GET
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}
Read a Tool
DELETE
/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}
Delete a Tool
DNS Forwarders (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) Add, remove, and update DNS for…
GET
/networking/v1/dns-forwarders
List of DNS Forwarders
POST
/networking/v1/dns-forwarders
Create a DNS Forwarder
GET
/networking/v1/dns-forwarders/{id}
Read a DNS Forwarder
PATCH
/networking/v1/dns-forwarders/{id}
Update a DNS Forwarder
DELETE
/networking/v1/dns-forwarders/{id}
Delete a DNS Forwarder
Access Points (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) AccessPoint objects represent n…
GET
/networking/v1/access-points
List of Access Points
POST
/networking/v1/access-points
Create an Access Point
GET
/networking/v1/access-points/{id}
Read an Access Point
PATCH
/networking/v1/access-points/{id}
Update an Access Point
DELETE
/networking/v1/access-points/{id}
Delete an Access Point
DNS Records (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) DNS record objects are associat…
GET
/networking/v1/dns-records
List of DNS Records
POST
/networking/v1/dns-records
Create a DNS Record
GET
/networking/v1/dns-records/{id}
Read a DNS Record
PATCH
/networking/v1/dns-records/{id}
Update a DNS Record
DELETE
/networking/v1/dns-records/{id}
Delete a DNS Record
Certificate Authorities (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) CertificateAuthority objects re…
GET
/iam/v2/certificate-authorities
List of Certificate Authorities
POST
/iam/v2/certificate-authorities
Create a Certificate Authority
GET
/iam/v2/certificate-authorities/{id}
Read a Certificate Authority
PUT
/iam/v2/certificate-authorities/{id}
Update a Certificate Authority
DELETE
/iam/v2/certificate-authorities/{id}
Delete a Certificate Authority
Certificate Identity Pools (iam/v2) 5
[](section/Versioning/API-Lifecycle-Policy) Identitypool objects represent…
GET
/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools
List of Certificate Identity Pools
POST
/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools
Create a Certificate Identity Pool
GET
/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}
Read a Certificate Identity Pool
PUT
/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}
Update a Certificate Identity Pool
DELETE
/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}
Delete a Certificate Identity Pool
Integrations (pim/v1) 4
[](section/Versioning/API-Lifecycle-Policy) Provider Integration objects re…
GET
/pim/v1/integrations
List of Integrations
POST
/pim/v1/integrations
Create an Integration
GET
/pim/v1/integrations/{id}
Read an Integration
DELETE
/pim/v1/integrations/{id}
Delete an Integration
Integrations (pim/v2) 6
[](section/Versioning/API-Lifecycle-Policy) [ 5
[](section/Versioning/API-Lifecycle-Policy) FlinkArtifact objects represent…
GET
/artifact/v1/flink-artifacts
List of Flink Artifacts
POST
/artifact/v1/flink-artifacts
Create a new Flink Artifact.
GET
/artifact/v1/flink-artifacts/{id}
Read a Flink Artifact
PATCH
/artifact/v1/flink-artifacts/{id}
Update a Flink Artifact
DELETE
/artifact/v1/flink-artifacts/{id}
Delete a Flink Artifact
Presigned Urls (artifact/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Request a presigned upload URL…
POST
/artifact/v1/presigned-upload-url
Request a presigned upload URL for a new Flink Artifact.
Gateways (networking/v1) 5
[](section/Versioning/API-Lifecycle-Policy) A Gateway represents a slice of…
GET
/networking/v1/gateways
List of Gateways
POST
/networking/v1/gateways
Create a Gateway
GET
/networking/v1/gateways/{id}
Read a Gateway
PATCH
/networking/v1/gateways/{id}
Update a Gateway
DELETE
/networking/v1/gateways/{id}
Delete a Gateway
Custom Code Loggings (ccl/v1) 5
[](section/Versioning/API-Lifecycle-Policy) [](section/Versioning/API-Lifecycle-Policy) Region objects represent cloud…
GET
/tableflow/v1/regions
List of Regions
Tableflow Topics (tableflow/v1) 5
[](section/Versioning/API-Lifecycle-Policy) A Tableflow Topic represents co…
GET
/tableflow/v1/tableflow-topics
List of Tableflow Topics
POST
/tableflow/v1/tableflow-topics
Create a Tableflow Topic
GET
/tableflow/v1/tableflow-topics/{display_name}
Read a Tableflow Topic
PATCH
/tableflow/v1/tableflow-topics/{display_name}
Update a Tableflow Topic
DELETE
/tableflow/v1/tableflow-topics/{display_name}
Delete a Tableflow Topic
Catalog Integrations (tableflow/v1) 5
[](section/Versioning/API-Lifecycle-Policy) A Catalog Integration represent…
GET
/tableflow/v1/catalog-integrations
List of Catalog Integrations
POST
/tableflow/v1/catalog-integrations
Create a Catalog Integration
GET
/tableflow/v1/catalog-integrations/{id}
Read a Catalog Integration
PATCH
/tableflow/v1/catalog-integrations/{id}
Update a Catalog Integration
DELETE
/tableflow/v1/catalog-integrations/{id}
Delete a Catalog Integration
Custom Connect Plugins (ccpm/v1) 5
[](section/Versioning/API-Lifecycle-Policy) CustomConnectPlugins objects re…
GET
/ccpm/v1/plugins
List of Custom Connect Plugins
POST
/ccpm/v1/plugins
Create a Custom Connect Plugin
GET
/ccpm/v1/plugins/{id}
Read a Custom Connect Plugin
PATCH
/ccpm/v1/plugins/{id}
Update a Custom Connect Plugin
DELETE
/ccpm/v1/plugins/{id}
Delete a Custom Connect Plugin
Presigned Urls (ccpm/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Request a presigned upload URL…
POST
/ccpm/v1/presigned-upload-url
Request a presigned upload URL for a new Custom Connect Plugin.
Custom Connect Plugin Versions (ccpm/v1) 4
[](section/Versioning/API-Lifecycle-Policy) CustomConnectPluginVersion obje…
GET
/ccpm/v1/plugins/{plugin_id}/versions
List of Custom Connect Plugin Versions
POST
/ccpm/v1/plugins/{plugin_id}/versions
Create a Custom Connect Plugin Version
GET
/ccpm/v1/plugins/{plugin_id}/versions/{id}
Read a Custom Connect Plugin Version
DELETE
/ccpm/v1/plugins/{plugin_id}/versions/{id}
Delete a Custom Connect Plugin Version
Kafka Clusters (usm/v1) 4
[](section/Versioning/API-Lifecycle-Policy) KafkaCluster object represent Confluent Platform Kafka clus…
GET
/usm/v1/kafka-clusters
List of Kafka Clusters
POST
/usm/v1/kafka-clusters
Create a Kafka Cluster
GET
/usm/v1/kafka-clusters/{id}
Read a Kafka Cluster
DELETE
/usm/v1/kafka-clusters/{id}
Delete a Kafka Cluster
Connect Clusters (usm/v1) 4
[](section/Versioning/API-Lifecycle-Policy) ConnectCluster object represent Confluent Platform Connect…
GET
/usm/v1/connect-clusters
List of Connect Clusters
POST
/usm/v1/connect-clusters
Create a Connect Cluster
GET
/usm/v1/connect-clusters/{id}
Read a Connect Cluster
DELETE
/usm/v1/connect-clusters/{id}
Delete a Connect Cluster
Endpoints (endpoint/v1) 1
[](section/Versioning/API-Lifecycle-Policy) An Endpoint object represents a…
GET
/endpoint/v1/endpoints
List of Endpoints
Rtce Topics (rtce/v1) 5
[](section/Versioning/API-Lifecycle-Policy) An RtceTopic represents a custo…
GET
/rtce/v1/rtce-topics
List of Rtce Topics
POST
/rtce/v1/rtce-topics
Create a Rtce Topic
GET
/rtce/v1/rtce-topics/{topic_name}
Read a Rtce Topic
PATCH
/rtce/v1/rtce-topics/{topic_name}
Update a Rtce Topic
DELETE
/rtce/v1/rtce-topics/{topic_name}
Delete a Rtce Topic
Regions (rtce/v1) 1
[](section/Versioning/API-Lifecycle-Policy) Region objects represent cloud…
GET
/rtce/v1/regions
List of Regions
Statements (query/v1alpha1) 2
Execute SQL statements against queryable topics and read their results. A statement that resolves quickly returns its results inline; a long-running one is assigned a background j…
POST
/query/v1alpha1
Execute SQL Statement
GET
/query/v1alpha1/jobs/{statement_id}/status
Query Async Job Status
Schemas 624
The contract defines 624 schemas that model the data the API accepts and returns. The most detailed are Entity (20 properties), billing.v1.Cost (18 properties), cdx.v1.ProviderSharedResource (17 properties), TagDefResponse (17 properties). Each schema is shown below with its type and property counts.
iam.v2.ApiKey
object
ApiKey objects represent access to different parts of Confluent Cloud. Some types of API keys represent access to a single cluster/resource such as a Kafka clu…
5 properties
SearchFilter
string
Filter a collection by a string search
iam.v2.ApiKeyList
object
ApiKey objects represent access to different parts of Confluent Cloud. Some types of API keys represent access to a single cluster/resource such as a Kafka clu…
4 properties
4 required
iam.v2.ApiKeySpec
object
The desired state of the Api Key
6 properties
ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties
1 required
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
ObjectReference
object
ObjectReference provides information for you to locate the referred object
6 properties
3 required
TypedGlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
5 properties
3 required
TypedEnvScopedObjectReference
object
ObjectReference provides information for you to locate the referred object
6 properties
3 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property
1 required
Error
object
Describes a particular error encountered while performing an operation.
8 properties
org.v2.Environment
object
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes. The API allows you to create, delete, and update…
6 properties
org.v2.Organization
object
Organization objects represent a customer organization. An organization contains all customer resources (e.g., Environments, Kafka Clusters, Service Accounts,…
6 properties
org.v2.StreamGovernanceConfig
object
Configurations pertaining to Stream Governance
1 property
1 required
org.v2.EnvironmentList
object
Environment objects represent an isolated namespace for your Confluent resources for organizational purposes. The API allows you to create, delete, and update…
4 properties
4 required
org.v2.OrganizationList
object
Organization objects represent a customer organization. An organization contains all customer resources (e.g., Environments, Kafka Clusters, Service Accounts,…
4 properties
4 required
iam.v2.User
object
User objects represent individuals who may access your Confluent resources. The API allows you to retrieve, update, and delete individual users, as well as lis…
7 properties
iam.v2.ServiceAccount
object
ServiceAccount objects are typically used to represent applications and other non-human principals that may access your Confluent resources. The API allows you…
6 properties
iam.v2.Invitation
object
Invitation objects represent invitations to invite users to join your organizations in Confluent Cloud. The API allows you to list all your invitations, as wel…
11 properties
iam.v2.User.ConfigureUserAuthRequest
object
Configure user auth type
5 properties
MultipleSearchFilter
array
Filter a collection by a string search for one or more values
iam.v2.UserList
object
User objects represent individuals who may access your Confluent resources. The API allows you to retrieve, update, and delete individual users, as well as lis…
4 properties
4 required
iam.v2.ServiceAccountList
object
ServiceAccount objects are typically used to represent applications and other non-human principals that may access your Confluent resources. The API allows you…
4 properties
4 required
iam.v2.InvitationList
object
Invitation objects represent invitations to invite users to join your organizations in Confluent Cloud. The API allows you to list all your invitations, as wel…
4 properties
4 required
GlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
3 properties
3 required
iam.v2.IpGroup
object
Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. The IP Groups Model
6 properties
iam.v2.IpFilter
object
IP Filter objects are bindings between IP Groups and Confluent resource(s). For example, a binding between "CorpNet" and "Management APIs" will enforce that ac…
9 properties
iam.v2.IpFilterSummary
object
The IP Filter Summary endpoint returns an aggregation of the IP Filters across the system. This API can be queried in the context of an organization or an envi…
4 properties
iam.v2.IpGroupList
object
Definitions of networks which can be named and referred by IP blocks, commonly used to attach to IP Filter rules. The IP Groups Model
4 properties
4 required
iam.v2.IpFilterList
object
IP Filter objects are bindings between IP Groups and Confluent resource(s). For example, a binding between "CorpNet" and "Management APIs" will enforce that ac…
4 properties
4 required
iam.v2.RoleBinding
object
A role binding grants a Principal a role on resources that match a pattern. The API allows you to perform create, delete, and list operations on role bindings.…
7 properties
iam.v2.RoleBindingList
object
A role binding grants a Principal a role on resources that match a pattern. The API allows you to perform create, delete, and list operations on role bindings.…
4 properties
4 required
notifications.v1.Subscription
object
Subscription objects represent the intent of the customers to get notifications of particular types. A subscription is created for a particular NotificationTyp…
7 properties
notifications.v1.Integration
object
You can create an Integration to specify how we can notify you when we receive an alert/notification for a subscription. Please note that you can only perform…
7 properties
notifications.v1.NotificationType
object
The type of notifications (and their corresponding metadata) supported by Confluent. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/curre…
11 properties
notifications.v1.ResourcePreference
object
ResourcePreference objects represent the intent of the customers to enable or disable all notifications at the resource level. A ResourcePreference is created…
7 properties
notifications.v1.ResourceSubscription
object
ResourceSubscription objects represent the intent of the customers to get notifications of particular types at the resource level. A ResourceSubscription is cr…
9 properties
notifications.v1.UserNotification
object
UserNotification objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Conflue…
13 properties
notifications.v1.SlackTarget
object
Target required for Slack integration
2 properties
2 required
notifications.v1.RoleEmailTarget
object
Email integration target to send email to all user with specified role
2 properties
2 required
notifications.v1.UserEmailTarget
object
Email integration target to send email to a particular user
2 properties
2 required
notifications.v1.WebhookTarget
object
Target required for webhook integration
2 properties
2 required
notifications.v1.MsTeamsTarget
object
Target required for MS Teams integration
2 properties
2 required
notifications.v1.InAppTarget
object
Per-user in-app notification target; lazy-onboarded on first read.
2 properties
2 required
notifications.v1.Target
Target for the particular integration
notifications.v1.ResourceSnapshot
object
Point-in-time snapshot of the Confluent Cloud resource a UserNotification relates to. Captured at delivery; values remain stable even if the underlying resourc…
3 properties
3 required
notifications.v1.NotificationAction
object
A user-facing action associated with a UserNotification. The first action on a notification is treated as the primary action; subsequent actions are secondary.
3 properties
3 required
notifications.v1.UpdateUserNotificationsReadRequest
object
Request body for setting the read state on every user notification matching the supplied filter query parameters.
1 property
1 required
notifications.v1.Summary
object
Summary of unread notifications for the authenticated user.
4 properties
4 required
notifications.v1.RecommendedActions
object
Versioned payload describing the recommended actions a user can take in response to a UserNotification. The shape is stable per version and consumers should br…
2 properties
2 required
BooleanFilter
boolean
Filter for whether this value is true or false.
notifications.v1.SubscriptionList
object
Subscription objects represent the intent of the customers to get notifications of particular types. A subscription is created for a particular NotificationTyp…
4 properties
4 required
notifications.v1.IntegrationList
object
You can create an Integration to specify how we can notify you when we receive an alert/notification for a subscription. Please note that you can only perform…
4 properties
4 required
notifications.v1.NotificationTypeList
object
The type of notifications (and their corresponding metadata) supported by Confluent. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/curre…
4 properties
4 required
notifications.v1.ResourceSubscriptionList
object
ResourceSubscription objects represent the intent of the customers to get notifications of particular types at the resource level. A ResourceSubscription is cr…
4 properties
4 required
notifications.v1.UserNotificationList
object
UserNotification objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Conflue…
4 properties
4 required
cmk.v2.Cluster
object
Clusters objects represent Apache Kafka Clusters on Confluent Cloud. The API allows you to list, create, read, update, and delete your Kafka clusters. Related…
6 properties
cmk.v2.ClusterStatus
object
The status of the Cluster
2 properties
1 required
cmk.v2.Basic
object
The basic cluster type.
2 properties
1 required
cmk.v2.Standard
object
The standard cluster type.
2 properties
1 required
cmk.v2.Enterprise
object
The enterprise cluster type.
2 properties
1 required
cmk.v2.Dedicated
object
A dedicated cluster with its parameters.
5 properties
2 required
cmk.v2.Freight
object
A freight cluster with its parameters.
3 properties
1 required
cmk.v2.EndpointsMap
object
Map of endpoints for a Kafka cluster, keyed by access point ID.
cmk.v2.Endpoints
object
Given a gateway type, endpoints to connect to the Kafka cluster.
3 properties
3 required
cmk.v2.ClusterList
object
Clusters objects represent Apache Kafka Clusters on Confluent Cloud. The API allows you to list, create, read, update, and delete your Kafka clusters. Related…
4 properties
4 required
cmk.v2.ClusterSpec
object
The desired state of the Cluster
13 properties
EnvScopedObjectReference
object
ObjectReference provides information for you to locate the referred object
4 properties
3 required
ksqldbcm.v2.Cluster
object
Cluster represents a ksqlDB runtime that you can issue queries to using its API endpoint. It executes SQL statements and queries which under the hood get built…
6 properties
ksqldbcm.v2.ClusterStatus
object
The status of the Cluster
5 properties
3 required
ksqldbcm.v2.ClusterList
object
Cluster represents a ksqlDB runtime that you can issue queries to using its API endpoint. It executes SQL statements and queries which under the hood get built…
4 properties
4 required
ksqldbcm.v2.ClusterSpec
object
The desired state of the Cluster
6 properties
connect.v1.ConnectorError
object
1 property
connect.v1.Connector
object
4 properties
2 required
connect.v1.ConnectorWithOffsets
object
5 properties
2 required
connect.v1.Connectors
array
List of active task configs that have been created by the connector
connect.v1.ConnectorExpansionMap
object
connect.v1.ConnectorExpansion
object
Name of connector
3 properties
connect.v1.Offsets
array
Array of offsets which are categorised into partitions.
connect.v1.ConnectorOffsets
object
Offsets for a connector
4 properties
connect.v1.AlterOffsetRequestType
string
The type of alter operation. PATCH will update the offset to the provided values. The update will only happen for the partitions provided in the request. DELET…
connect.v1.AlterOffsetRequest
object
Request to alter the offset of a connector. The offsets parameter is options for DELETE type.
2 properties
1 required
connect.v1.AlterOffsetRequestInfo
object
The request made to alter offsets.
5 properties
4 required
connect.v1.AlterOffsetStatus
object
Status of the alter offset operation. The previous offsets in the response is the offsets that the connector last processed, before the offsets were altered, v…
4 properties
2 required
cam.v1.ConnectArtifact
object
Connect Artifact objects represent collection of Custom SMTs, user-defined message transformations that can be applied to Kafka connectors. The API allows you…
6 properties
cam.v1.ConnectArtifactStatus
object
The status of the Connect Artifact
1 property
1 required
cam.v1.PresignedUrl
object
Request a presigned upload URL for new Connect Artifact. Note that the URL policy expires in one hour. If the policy expires, you can request a new presigned u…
8 properties
cam.v1.ConnectArtifactSpec
object
Connect Artifact objects represent Custom SMTs on Confluent Cloud.
8 properties
3 required
cam.v1.Plugins
object
Metadata of the classes present in a Connect Artifact.
1 property
cam.v1.Usages
object
Specifies a resource CRN and connector type where this Connect artifact is being used.
2 properties
2 required
cam.v1.PresignedUrlRequest
object
Request schema of the presigned upload URL.
7 properties
cam.v1.UploadSource.PresignedUrl
object
Presigned URL of the uploaded Connect Artifact archive.
2 properties
2 required
cam.v1.ConnectArtifactList
object
Connect Artifact objects represent collection of Custom SMTs, user-defined message transformations that can be applied to Kafka connectors. The API allows you…
4 properties
4 required
connect.v1.CustomConnectorPlugin
object
CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. The API allows you to list, create, read, update, and delete your Custom…
14 properties
connect.v1.PresignedUrl
object
Request a presigned upload URL for new Custom Connector Plugin. Note that the URL policy expires in one hour. If the policy expires, you can request a new pres…
7 properties
connect.v1.CustomConnectorRuntime
object
List of supported runtime languages for Custom Connector Plugin. The list defines the supported entries for confluent.custom.connect.plugin.runtime attribute i…
9 properties
connect.v1.PresignedUrlRequest
object
Request schema of the presigned upload URL.
6 properties
connect.v1.UploadSource.PresignedUrl
object
Presigned URL of the uploaded Custom Connector Plugin archive.
2 properties
2 required
connect.v1.CustomConnectorPluginList
object
CustomConnectorPlugins objects represent Custom Connector Plugins on Confluent Cloud. The API allows you to list, create, read, update, and delete your Custom…
4 properties
4 required
connect.v1.CustomConnectorRuntimeList
object
List of supported runtime languages for Custom Connector Plugin. The list defines the supported entries for confluent.custom.connect.plugin.runtime attribute i…
4 properties
4 required
AbstractConfigData
AclData
AclDataList
AclOperation
string
AclPatternType
string
AclPermission
string
AclResourceType
string
AlterConfigBatchRequestData
object
2 properties
1 required
AnyValue
AuthorizedOperations
array
BrokerConfigData
BrokerConfigDataList
BrokerData
BrokerDataList
ClusterConfigData
ClusterConfigDataList
ClusterConfigType
string
ClusterData
ClusterDataList
CreateAclRequestData
object
7 properties
7 required
CreateAclRequestDataList
CreateTopicRequestData
object
5 properties
1 required
ConfigSource
string
ConfigSynonymData
object
3 properties
2 required
ConsumerAssignmentData
ConsumerAssignmentDataList
ConsumerData
ConsumerDataList
ConsumerGroupData
ConsumerGroupDataList
ConsumerGroupState
string
ConsumerGroupType
string
ConsumerLagData
ConsumerLagDataList
ConsumerGroupLagSummaryData
PartitionData
PartitionDataList
ProduceResponse
object
9 properties
1 required
ProduceResponseData
object
2 properties
2 required
ProduceRequest
object
5 properties
ProduceRequestData
object
2 properties
ProduceRequestHeader
object
2 properties
1 required
ReassignmentData
ReassignmentDataList
Relationship
object
1 property
1 required
ReplicaData
ReplicaDataList
Resource
object
2 properties
2 required
ResourceCollection
object
2 properties
2 required
ResourceCollectionMetadata
object
2 properties
1 required
ResourceMetadata
object
2 properties
1 required
ShareGroupConsumerAssignmentData
ShareGroupConsumerAssignmentDataList
ShareGroupDataList
ShareGroupData
ShareGroupState
string
ShareGroupTopicPartitionData
ShareGroupConsumerData
ShareGroupConsumerDataList
GroupConfigData
GroupConfigDataList
UpdateGroupConfigRequestData
object
1 property
1 required
TopicConfigData
TopicConfigDataList
TopicData
TopicDataList
UpdateConfigRequestData
object
1 property
UpdatePartitionCountRequestData
object
1 property
1 required
StreamsGroupState
string
The state of the Streams group.
AssignmentsType
string
The type of the Streams task assignments.
StreamsGroupDataList
The list of Streams groups.
StreamsGroupData
The details of a Streams group.
StreamsGroupSubtopologyDataList
The list of Streams group subtopologies.
StreamsGroupSubtopologyData
The details of a Streams group subtopology.
StreamsGroupMemberDataList
The list of Streams group members.
StreamsGroupMemberData
The details of a Streams group member.
StreamsGroupMemberAssignmentData
The assignment details of a Streams group member.
StreamsTaskDataList
The list of Streams tasks.
StreamsTaskData
The details of a Streams task.
ReplicaStatusData
ReplicaStatusDataList
AnyUnevenLoadData
BalancerStatusData
BrokerRemovalData
BrokerRemovalDataList
BrokerTaskData
BrokerTaskDataList
BrokerReplicaExclusionRequestData
object
2 properties
2 required
BrokerReplicaExclusionBatchRequestData
object
1 property
1 required
BrokerReplicaExclusionData
BrokerReplicaExclusionDataList
AlterBrokerReplicaExclusionData
AlterBrokerReplicaExclusionDataList
RemoveBrokerTaskData
RemoveBrokerTaskDataList
ConfigData
object
2 properties
2 required
CreateLinkRequestData
object
5 properties
UpdateLinkConfigRequestData
object
1 property
1 required
LinkState
string
LinkError
string
LinkTask
object
3 properties
3 required
LinkCategory
object
2 properties
2 required
StateCategory
string
LinkTaskError
object
2 properties
2 required
LinkTaskState
string
LinkTaskErrorCode
string
ListLinksResponseData
ListLinksResponseDataList
ListLinkConfigsResponseData
ListLinkConfigsResponseDataList
CreateMirrorTopicRequestData
object
4 properties
1 required
AlterMirrorsRequestData
object
2 properties
ListMirrorTopicsResponseData
ListMirrorTopicsResponseDataList
AlterMirrorStatusResponseData
AlterMirrorStatusResponseDataList
RemoveBrokersRequestData
object
1 property
1 required
PartitionLevelTruncationDataList
array
PartitionLevelTruncationData
object
3 properties
3 required
MirrorLags
array
MirrorLag
object
3 properties
3 required
MirrorTopicStatus
string
MirrorTopicError
string
AnyUnevenLoadStatus
string
BalancerStatus
string
BrokerTaskType
string
BrokerTaskStatus
string
ExclusionOp
string
BrokerReplicaExclusionStatus
string
DeprecatedPartitionReassignmentStatus
string
DeprecatedBrokerShutdownStatus
string
service-quota.v1.AppliedQuota
object
A quota object represents a quota configuration for a specific Confluent Cloud resource. Use this API to retrieve an individual quota or list of quotas for a g…
14 properties
service-quota.v1.Scope
object
Gets a list of all available scopes for applied quotas. Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.htmlquery-for-scope…
5 properties
service-quota.v1.AppliedQuotaList
object
A quota object represents a quota configuration for a specific Confluent Cloud resource. Use this API to retrieve an individual quota or list of quotas for a g…
4 properties
4 required
service-quota.v1.ScopeList
object
Gets a list of all available scopes for applied quotas. Related guide: [Quota Scopes](https://docs.confluent.io/cloud/current/quotas/quotas.htmlquery-for-scope…
4 properties
4 required
partner.v2.Entitlement
object
Entitlement objects represent metadata about a marketplace entitlement.
11 properties
partner.v2.EntitlementList
object
Entitlement objects represent metadata about a marketplace entitlement.
4 properties
4 required
srcm.v2.Region
object
Region objects represent cloud provider regions available when placing Schema Registry clusters. The API allows you to list Schema Registry regions. Related gu…
5 properties
srcm.v2.Cluster
object
Clusters objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list, create, read, and delete your Schema Registry clusters. Rel…
6 properties
srcm.v2.ClusterStatus
object
The status of the Cluster
1 property
1 required
srcm.v2.RegionList
object
Region objects represent cloud provider regions available when placing Schema Registry clusters. The API allows you to list Schema Registry regions. Related gu…
4 properties
4 required
srcm.v2.RegionSpec
object
The desired state of the Region
4 properties
srcm.v2.ClusterList
object
Clusters objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list, create, read, and delete your Schema Registry clusters. Rel…
4 properties
4 required
srcm.v2.ClusterSpec
object
The desired state of the Cluster
5 properties
srcm.v3.Cluster
object
Clusters objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list and read your Schema Registry clusters. Related guide: [Conf…
6 properties
srcm.v3.ClusterStatus
object
The status of the Cluster
1 property
1 required
srcm.v3.ClusterList
object
Clusters objects represent Schema Registry Clusters on Confluent Cloud. The API allows you to list and read your Schema Registry clusters. Related guide: [Conf…
4 properties
4 required
srcm.v3.ClusterSpec
object
The desired state of the Cluster
9 properties
ClusterConfig
object
Cluster Config
2 properties
CompatibilityCheckResponse
object
Compatibility check response
2 properties
ErrorMessage
object
Error message of this operation
2 properties
RegisterExporterRequest
object
Exporter register request
1 property
RegisterSchemaRequest
object
Schema register request
10 properties
ExporterUpdateRequest
object
Exporter update request
6 properties
ExporterStatusResponse
object
Exporter status get request
5 properties
ExporterConfigResponse
object
The map containing exporter's configurations
3 properties
SchemaReference
object
Schema reference
3 properties
ExporterReference
object
The format for a typical exporter object
7 properties
Config
object
Config
8 properties
ConfigUpdateRequest
object
Config update request
8 properties
Mode
object
Schema Registry operating mode
1 property
ModeUpdateRequest
object
Mode update request
1 property
SchemaString
object
Schema definition
7 properties
Schema
object
Schema
9 properties
SubjectVersion
object
Subject version pair
2 properties
ExporterResponse
object
Exporter register response
1 property
RegisterSchemaResponse
object
Schema register response
1 property
Dek
object
8 properties
CreateDekRequest
object
5 properties
Kek
object
8 properties
CreateKekRequest
object
7 properties
UpdateKekRequest
object
3 properties
Metadata
object
User-defined metadata
3 properties
RuleSet
object
Schema rule set
2 properties
Rule
object
Rule
11 properties
SchemaEntity
object
2 properties
SchemaTags
object
2 properties
ServerClusterId
object
2 properties
SchemaRegistryServerVersion
object
2 properties
Tag
object
9 properties
TimeBoundary
object
3 properties
Classification
object
7 properties
ClassificationHeader
object
5 properties
Entity
object
The entity
20 properties
EntityWithExtInfo
object
2 properties
EntityPartialUpdateResponse
object
The type name
1 property
TermAssignmentHeader
object
10 properties
EntityHeader
object
11 properties
EntityPartialUpdate
object
The updated entities.
1 property
PartialUpdateParams
object
7 properties
SearchParams
object
Search paramas to filter results
3 properties
SearchResult
object
4 properties
AttributeDef
object
16 properties
ConstraintDef
object
2 properties
TagDef
object
16 properties
BusinessMetadataResponse
object
5 properties
BusinessMetadata
object
4 properties
BusinessMetadataDefResponse
object
14 properties
BusinessMetadataDef
object
13 properties
TagResponse
object
10 properties
TagDefResponse
object
17 properties
cdx.v1.ProviderSharedResource
object
ProviderSharedResource object contains details of the data stream (topic, schema registry subjects, sharing metadata) that you have shared through Stream Shari…
17 properties
cdx.v1.ProviderShare
object
ProviderShare object respresents the share that you have created through Stream Sharing. Related guide: [Provider Stream Shares in Confluent Cloud](https://doc…
16 properties
cdx.v1.ProviderShareStatus
object
The status of the Provider Share
1 property
1 required
cdx.v1.ConsumerSharedResource
object
ConsumerSharedResource object contains details of the data stream (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing.…
14 properties
cdx.v1.ConsumerShare
object
ConsumerShare object respresents the share that you received through Stream Sharing. Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.co…
11 properties
cdx.v1.ConsumerShareStatus
object
The status of the Consumer Share
1 property
1 required
cdx.v1.SharedToken
object
Encrypted Token shared with consumer The Shared Tokens Model
5 properties
cdx.v1.OptIn
object
Stream sharing opt in options The Opt Ins Model
3 properties
cdx.v1.CreateProviderShareRequest
object
Create share request
7 properties
cdx.v1.RedeemTokenRequest
object
Redeem share with token request parameters
8 properties
cdx.v1.RedeemTokenResponse
object
Share details for the consumer org or user
11 properties
cdx.v1.EmailConsumerRestriction
object
Consumer restrictions limits by authenticated user's email
2 properties
2 required
cdx.v1.SharedTopic
object
The shared resource details
2 properties
2 required
cdx.v1.SharedGroup
object
The shared consumer group
2 properties
2 required
cdx.v1.SharedSubject
object
The shared resource details
2 properties
2 required
cdx.v1.Network
object
The shared cluster's network configurations for consumer to setup private link
9 properties
cdx.v1.AwsNetwork
object
The AWS network details.
2 properties
1 required
cdx.v1.AzureNetwork
object
The Azure network details.
2 properties
1 required
cdx.v1.GcpNetwork
object
The GCP network details.
2 properties
1 required
cdx.v1.ConnectionType
string
Network connection type.
cdx.v1.Schema
object
Schema
5 properties
cdx.v1.ProviderSharedResourceList
object
ProviderSharedResource object contains details of the data stream (topic, schema registry subjects, sharing metadata) that you have shared through Stream Shari…
4 properties
4 required
cdx.v1.ProviderShareList
object
ProviderShare object respresents the share that you have created through Stream Sharing. Related guide: [Provider Stream Shares in Confluent Cloud](https://doc…
4 properties
4 required
cdx.v1.ConsumerSharedResourceList
object
ConsumerSharedResource object contains details of the data stream (topic, schema registry subjects, sharing metadata) that you received through Stream Sharing.…
4 properties
4 required
cdx.v1.ConsumerShareList
object
ConsumerShare object respresents the share that you received through Stream Sharing. Related guide: [Consumer Stream Shares in Confluent Cloud](https://docs.co…
4 properties
4 required
partner.v2.Organization
object
Organizations objects represent an entire Confluent Cloud organization.
7 properties
AzureSSOConfig
object
2 properties
2 required
partner.v2.OrganizationList
object
Organizations objects represent an entire Confluent Cloud organization.
4 properties
4 required
PartnerSignupRequest
object
The partner signup request
3 properties
2 required
PartnerSignupResponse
object
The partner signup response
3 properties
2 required
ActivatePartnerSignupRequest
object
The partner signup activation request
2 properties
2 required
PartnerLinkRequest
object
The partner linking request
3 properties
3 required
v2.User
object
networking.v1.Network
object
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts. Dedicated networks support more net…
6 properties
networking.v1.NetworkStatus
object
The status of the Network
10 properties
3 required
networking.v1.Peering
object
Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. Related guides: [Use VPC peering connections with Confluent Cloud on AWS]…
6 properties
networking.v1.PeeringStatus
object
The status of the Peering
3 properties
1 required
networking.v1.TransitGatewayAttachment
object
AWS Transit Gateway Attachments Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-…
6 properties
networking.v1.TransitGatewayAttachmentStatus
object
The status of the Transit Gateway Attachment
4 properties
1 required
networking.v1.PrivateLinkAccess
object
Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. Related guides: [Use Google Cloud Private Service Connect…
6 properties
networking.v1.PrivateLinkAccessStatus
object
The status of the Private Link Access
3 properties
1 required
networking.v1.NetworkLinkService
object
Network Link Service is associated with a Private Link Confluent Cloud Network. It enables connectivity from other Private Link Confluent Cloud Networks based…
6 properties
networking.v1.NetworkLinkServiceStatus
object
The status of the Network Link Service
3 properties
1 required
networking.v1.NetworkLinkEndpoint
object
A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a Network Link Service (associated with another Private Link…
6 properties
networking.v1.NetworkLinkEndpointStatus
object
The status of the Network Link Endpoint
4 properties
1 required
networking.v1.NetworkLinkServiceAssociation
object
List of incoming Network Link Enpoints associated with the Network Link Service. Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/curr…
6 properties
networking.v1.NetworkLinkServiceAssociationStatus
object
The status of the Network Link Service Association
4 properties
1 required
networking.v1.Cidr
string
IPv4 CIDR block
networking.v1.ConnectionType
string
Network connection type.
networking.v1.DnsConfig
object
The network DNS config
1 property
1 required
networking.v1.AwsNetwork
object
The AWS network details.
4 properties
3 required
networking.v1.GcpNetwork
object
The GCP network details.
4 properties
3 required
networking.v1.AzureNetwork
object
The Azure network details.
5 properties
3 required
networking.v1.AwsPeering
object
AWS VPC Peering.
5 properties
5 required
networking.v1.GcpPeering
object
GCP VPC Peering.
4 properties
3 required
networking.v1.AzurePeering
object
Azure VNet Peering.
4 properties
4 required
networking.v1.AwsTransitGatewayAttachment
object
AWS Transit Gateway Attachment.
4 properties
4 required
networking.v1.AwsTransitGatewayAttachmentStatus
object
AWS Transit Gateway Attachment details generated by AWS.
2 properties
1 required
networking.v1.AwsPrivateLinkAccess
object
AWS PrivateLink access configuration.
2 properties
2 required
networking.v1.AzurePrivateLinkAccess
object
Azure PrivateLink access configuration.
2 properties
2 required
networking.v1.GcpPrivateServiceConnectAccess
object
GCP Private Service Connect access configuration.
2 properties
2 required
networking.v1.NetworkLinkServiceAcceptPolicy
object
List of environments/networks from which connections can be accepted on this network link service.
2 properties
networking.v1.ZoneInfo
object
Cloud provider zone metadata.
2 properties
networking.v1.NetworkList
object
Network represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts. Dedicated networks support more net…
4 properties
4 required
networking.v1.NetworkSpec
object
The desired state of the Network
11 properties
networking.v1.PeeringList
object
Add or remove VPC/VNet peering connections between your VPC/VNet and Confluent Cloud. Related guides: [Use VPC peering connections with Confluent Cloud on AWS]…
4 properties
4 required
networking.v1.PeeringSpec
object
The desired state of the Peering
4 properties
networking.v1.TransitGatewayAttachmentList
object
AWS Transit Gateway Attachments Related guide: [APIs to manage AWS Transit Gateway Attachments](https://docs.confluent.io/cloud/current/networking/aws-transit-…
4 properties
4 required
networking.v1.TransitGatewayAttachmentSpec
object
The desired state of the Transit Gateway Attachment
4 properties
networking.v1.PrivateLinkAccessList
object
Add or remove access to PrivateLink endpoints by AWS account, Azure subscription and GCP project ID. Related guides: [Use Google Cloud Private Service Connect…
4 properties
4 required
networking.v1.PrivateLinkAccessSpec
object
The desired state of the Private Link Access
4 properties
networking.v1.NetworkLinkServiceList
object
Network Link Service is associated with a Private Link Confluent Cloud Network. It enables connectivity from other Private Link Confluent Cloud Networks based…
4 properties
4 required
networking.v1.NetworkLinkServiceSpec
object
The desired state of the Network Link Service
5 properties
networking.v1.NetworkLinkEndpointList
object
A Network Link Enpoint is associated with a Private Link Confluent Cloud Network at the origin and a Network Link Service (associated with another Private Link…
4 properties
4 required
networking.v1.NetworkLinkEndpointSpec
object
The desired state of the Network Link Endpoint
5 properties
networking.v1.NetworkLinkServiceAssociationList
object
List of incoming Network Link Enpoints associated with the Network Link Service. Related guide: [Network Linking Overview](https://docs.confluent.io/cloud/curr…
4 properties
4 required
networking.v1.NetworkLinkServiceAssociationSpec
object
The desired state of the Network Link Service Association
5 properties
networking.v1.IpAddress
object
IP Addresses Related guide: [Use Public Egress IP addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.h…
7 properties
networking.v1.IpAddressList
object
IP Addresses Related guide: [Use Public Egress IP Addresses on Confluent Cloud](https://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.h…
4 properties
4 required
networking.v1.PrivateLinkAttachment
object
PrivateLink attachment objects represent reservations to establish PrivateLink connections to a cloud region in order to access resources that belong to a Conf…
6 properties
networking.v1.PrivateLinkAttachmentStatus
object
The status of the Private Link Attachment
5 properties
1 required
networking.v1.PrivateLinkAttachmentConnection
object
PrivateLink attachment connection objects represent connections established to a cloud region in order to access resources that belong to a Confluent Cloud Env…
6 properties
networking.v1.PrivateLinkAttachmentConnectionStatus
object
The status of the Private Link Attachment Connection
4 properties
1 required
networking.v1.AwsPrivateLinkAttachmentStatus
object
AWS PrivateLink attachment represents reserved capacity in an AWS VPC Endpoint Service that can be used to establish PrivateLink connections.
2 properties
2 required
networking.v1.AwsVpcEndpointService
object
AWS VPC Endpoint service that can be used to create VPC Endpoints.
1 property
1 required
networking.v1.AzurePrivateLinkAttachmentStatus
object
Azure PrivateLink attachment represents reserved capacity in a PrivateLink service that can be used to establish PrivateLink
2 properties
2 required
networking.v1.AzurePrivateLinkService
object
Azure Private Link Service with reserved capacity to connect a Private Endpoint.
2 properties
2 required
networking.v1.GcpPrivateLinkAttachmentStatus
object
GCP PrivateLink attachment represents reserved capacity in a GCP PSC Service attachment. A PSC Endpoint can be connected to the Service attachment.
2 properties
2 required
networking.v1.GcpPscServiceAttachment
object
GCP PSC Service attachment with reserved capacity to connect a PSC Endpoint.
1 property
1 required
networking.v1.AwsPrivateLinkAttachmentConnectionStatus
object
Status of a connection to an AWS PrivateLink attachment.
3 properties
3 required
networking.v1.AzurePrivateLinkAttachmentConnectionStatus
object
Status of a Azure PrivateLink attachment connection.
4 properties
4 required
networking.v1.GcpPrivateLinkAttachmentConnectionStatus
object
Status of GCP PrivateLink attachment connection.
3 properties
3 required
networking.v1.AwsPrivateLinkAttachmentConnection
object
Represents a connection between an AWS VPC Endpoint and an Endpoint service.
2 properties
2 required
networking.v1.AzurePrivateLinkAttachmentConnection
object
Represents a connection between an Azure PrivateLink service and a PrivateEndpoint.
2 properties
2 required
networking.v1.GcpPrivateLinkAttachmentConnection
object
Represents a connection between a GCP PSC Service Attachment and a PSC Endpoint.
2 properties
2 required
networking.v1.PrivateLinkAttachmentList
object
PrivateLink attachment objects represent reservations to establish PrivateLink connections to a cloud region in order to access resources that belong to a Conf…
4 properties
4 required
networking.v1.PrivateLinkAttachmentSpec
object
The desired state of the Private Link Attachment
4 properties
networking.v1.PrivateLinkAttachmentConnectionList
object
PrivateLink attachment connection objects represent connections established to a cloud region in order to access resources that belong to a Confluent Cloud Env…
4 properties
4 required
networking.v1.PrivateLinkAttachmentConnectionSpec
object
The desired state of the Private Link Attachment Connection
4 properties
iam.v2.IdentityProvider
object
IdentityProvider objects represent external OAuth-OIDC providers in Confluent Cloud. The API allows you to list, create, read, update, and delete your Identity…
11 properties
iam.v2.Jwks
object
JWKS objects represent public key sets for a specific OAuth/OpenID Connect provider within Confluent Cloud. The API allows you to refresh JWKS public key data.…
4 properties
iam.v2.JwksStatus
object
The status of the Jwks
2 properties
iam.v2.IdentityPool
object
IdentityPool objects represent groups of identities tied to a given a IdentityProvider that authorizes them to Confluent Cloud resources. It provides a mapping…
10 properties
iam.v2.JwksObject
object
JWKS contains the published keys for the given OpenIDProvider
6 properties
3 required
iam.v2.IdentityProviderList
object
IdentityProvider objects represent external OAuth-OIDC providers in Confluent Cloud. The API allows you to list, create, read, update, and delete your Identity…
4 properties
4 required
iam.v2.JwksSpec
object
The desired state of the Jwks
1 property
iam.v2.IdentityPoolList
object
IdentityPool objects represent groups of identities tied to a given a IdentityProvider that authorizes them to Confluent Cloud resources. It provides a mapping…
4 properties
4 required
sts.v1.TokenExchangeRequest
object
token exchange request parameters
10 properties
sts.v1.TokenExchangeReply
object
token exchange response
4 properties
4 required
kafka-quotas.v1.ClientQuota
object
ClientQuota objects represent Client Quotas you can set at the service account level. The API allows you to list, create, read, update, and delete your client…
5 properties
kafka-quotas.v1.Throughput
object
Quotas on maximum throughput
2 properties
2 required
kafka-quotas.v1.ClientQuotaList
object
ClientQuota objects represent Client Quotas you can set at the service account level. The API allows you to list, create, read, update, and delete your client…
4 properties
4 required
kafka-quotas.v1.ClientQuotaSpec
object
The desired state of the Client Quota
6 properties
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.KeyValidation
object
The validation details of the key.
4 properties
2 required
byok.v1.AwsKey
object
The AWS BYOK details
3 properties
2 required
byok.v1.AzureKey
object
The Azure BYOK details.
5 properties
4 required
byok.v1.GcpKey
object
The GCP BYOK details
3 properties
2 required
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
billing.v1.Cost
object
Cost objects represent the aggregated billing costs for an organization Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/cu…
18 properties
billing.v1.Resource
object
The resource associated with this object. The resource can be one of Kafka Cluster ID (example: lkc-12345), Connector ID (example: lcc-12345), Schema Registry…
3 properties
billing.v1.Environment
object
The details of the environment for a given resource.
1 property
billing.v1.CostList
object
Cost objects represent the aggregated billing costs for an organization Related guide: [Retrieve costs for a range of dates](https://docs.confluent.io/cloud/cu…
4 properties
4 required
CostListMeta
object
CostListMeta describes metadata that resource collections may have
1 property
iam.v2.sso.GroupMapping
object
GroupMapping objects establish relationships between user groups in your SSO identity provider and specific RBAC roles in Confluent Cloud. Group mappings enabl…
9 properties
iam.v2.sso.GroupMappingList
object
GroupMapping objects establish relationships between user groups in your SSO identity provider and specific RBAC roles in Confluent Cloud. Group mappings enabl…
4 properties
4 required
fcpm.v2.ComputePool
object
A Compute Pool represents a set of compute resources that is used to run your Queries. The resources (CPUs, memory,…) provided by a Compute Pool are shared bet…
6 properties
fcpm.v2.ComputePoolStatus
object
The status of the Compute Pool
2 properties
2 required
fcpm.v2.Region
object
Region objects represent cloud provider regions available when placing Flink compute pools. The API allows you to list Flink regions. The Regions Model
9 properties
fcpm.v2.OrgComputePoolConfig
object
OrgComputePoolConfig manages compute pool configuration settings for an organization. The API allows you to read and update organization-wide settings such as…
4 properties
fcpm.v2.ComputePoolList
object
A Compute Pool represents a set of compute resources that is used to run your Queries. The resources (CPUs, memory,…) provided by a Compute Pool are shared bet…
4 properties
4 required
fcpm.v2.ComputePoolSpec
object
The desired state of the Compute Pool
8 properties
fcpm.v2.RegionList
object
Region objects represent cloud provider regions available when placing Flink compute pools. The API allows you to list Flink regions. The Regions Model
4 properties
4 required
sql.v1.MaterializedTable
object
Represents a Materialized Table resource.
8 properties
7 required
sql.v1.MaterializedTableList
object
A list of Materialized Table resources.
4 properties
4 required
sql.v1.MaterializedTableSpec
object
The specifications of the Materialized Table.
11 properties
sql.v1.MaterializedTableStatus
object
The status of the Materialized Table.
7 properties
sql.v1.MaterializedTableVersion
object
Represents a specific version of a Materialized Table resource.
7 properties
7 required
sql.v1.MaterializedTableVersionList
object
A list of Materialized Table Version resources.
4 properties
4 required
sql.v1.MaterializedTableVersionSpec
object
The specifications of the Materialized Table Version.
3 properties
2 required
sql.v1.ResourceChange
object
Details of a change to a specific resource.
5 properties
5 required
sql.v1.ColumnDetails
object
Details of a column in the Materialized Table.
sql.v1.ColumnCommon
object
3 properties
2 required
sql.v1.PhysicalColumn
Physical columns define the structure of the table and the data types of its fields.
sql.v1.MetadataColumn
Metadata columns reference system properties.
sql.v1.ComputedColumn
Computed columns are generated via an expression.
sql.v1.Watermark
object
Watermark strategy for the Materialized Table resource.
2 properties
sql.v1.Constraint
object
A constraint on the materialized table.
4 properties
sql.v1.Distribution
object
Distribution (bucket by) strategy.
3 properties
1 required
sql.v1.MaterializedTableWarning
object
Represents a non-fatal issue encountered during materialized table processing.
sql.v1.Connection
object
Connection models a reusable endpoint and auth token to authenticate the caller to use that endpoint. Only OrganizationAdmins and EnvironmentAdmins will have t…
6 properties
sql.v1.ConnectionList
object
Connection models a reusable endpoint and auth token to authenticate the caller to use that endpoint. Only OrgAdmins and EnvAdmins will have the permissions to…
4 properties
4 required
sql.v1.ConnectionStatus
object
The status of the Connection
2 properties
1 required
sql.v1.PlaintextProvider
object
Describes a sensitive piece of information passed in plaintext. Confluent only accepts authentication tokens of supported model providers from OrgAdmins and En…
2 properties
sql.v1.ConnectionSpec
object
Encapsulates the model provider access details
3 properties
sql.v1.Agent
object
Represents an Agent resource.
8 properties
7 required
sql.v1.AgentList
object
A list of Agent resources.
4 properties
4 required
sql.v1.AgentSpec
object
The specifications of the Agent.
5 properties
sql.v1.AgentStatus
object
The status of the Agent.
1 property
sql.v1.ToolList
object
Tool models a reusable tool resource backed by a connection that can be referenced by agents to perform actions. The API allows you to create your tools. The T…
4 properties
4 required
sql.v1.Tool
object
Tool models a reusable tool resource backed by a connection that can be referenced by agents to perform actions. The API allows you to create your tools. The T…
6 properties
sql.v1.ToolSpec
object
The spec of the Tool. A tool must reference either a connection (for MCP or A2A tools) or a function (for function-based tools), but not both.
4 properties
sql.v1.ToolStatus
object
The status of the Tool
2 properties
1 required
sql.v1.Statement
object
Statement represents a core resource used to model SQL statements for execution. A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle ses…
9 properties
sql.v1.StatementStatus
object
The status of the Statement
13 properties
1 required
sql.v1.StatementTraits
object
StatementTraits contains detailed information about the properties of a Statement
6 properties
sql.v1.StatementList
object
Statement represents a core resource used to model SQL statements for execution. A statement generalizes DDL, DML, DQL, etc., but doesn’t attempt to handle ses…
4 properties
4 required
sql.v1.StatementResult
object
Statement Result represents a resource used to model results of SQL statements. The API allows you to read your SQL statement result.
4 properties
4 required
sql.v1.StatementResultResults
object
A results property that contains a data property that contains an array of results.
1 property
sql.v1.StatementSpec
object
The specs of the Statement
7 properties
StatementObjectMeta
object
The metadata of the statement.
6 properties
1 required
ResultListMeta
object
ListMeta describes metadata that resource collections may have
3 properties
sql.v1.ScalingSpec
object
Mutable scaling configuration that can be updated for a running statement.
1 property
sql.v1.ScalingStatus
object
Scaling status for this statement.
2 properties
sql.v1.StateLimitStatus
object
State limit status for this statement.
3 properties
sql.v1.ResultSchema
object
The table columns of the results schema.
1 property
ColumnDetails
object
A column in the results schema.
2 properties
2 required
DataType
object
12 properties
2 required
RowFieldType
object
3 properties
2 required
sql.v1.StatementWarning
object
Represents a non-fatal issue encountered during statement processing.
4 properties
4 required
sql.v1.WarningSeverity
string
Indicates the severity of the warning. LOW: Indicates a low severity warning and for informing the user. MODERATE: Indicates a moderate severity warning and ma…
ExceptionListMeta
object
ListMeta describes metadata that resource collections may have
1 property
sql.v1.StatementExceptionList
object
StatementExceptionList is a list of exceptions coming from FAILED or FAILING Statements created by the SQL Statements API.
4 properties
4 required
sql.v1.StatementException
object
4 properties
PatchRequest
array
PatchRequest represent a json-patch request to be applied to the Statement. See https://tools.ietf.org/html/rfc6902
JsonPatchRequestAddReplace
object
This option is used to add or replace a value for a field
3 properties
3 required
JsonPatchRequestRemove
object
This option is used to remove a field
2 properties
2 required
JsonPatchRequestMoveCopy
object
This option is used to move or copy a field
3 properties
3 required
networking.v1.DnsForwarder
object
Add, remove, and update DNS forwarder for your gateway. Related guides: [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/clo…
6 properties
networking.v1.DnsForwarderStatus
object
The status of the Dns Forwarder
3 properties
1 required
networking.v1.Ip
string
IPv4 Address
networking.v1.ForwardViaIp
object
DNS Forwarder Configured via DNS Server IPs.
2 properties
2 required
networking.v1.DnsForwarderList
object
Add, remove, and update DNS forwarder for your gateway. Related guides: [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/clo…
4 properties
4 required
networking.v1.DnsForwarderSpec
object
The desired state of the Dns Forwarder
5 properties
networking.v1.AccessPoint
object
AccessPoint objects represent network connections in and out of Gateways. This API allows you to list, create, read, update, and delete your access points. The…
6 properties
networking.v1.AccessPointStatus
object
The status of the Access Point
4 properties
1 required
networking.v1.DnsRecord
object
DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. Th…
6 properties
networking.v1.DnsRecordStatus
object
The status of the Dns Record
3 properties
1 required
networking.v1.AwsEgressPrivateLinkEndpoint
object
AWS VPC Endpoint.
4 properties
2 required
networking.v1.AwsIngressPrivateLinkEndpoint
object
AWS Ingress Private Link Endpoint.
2 properties
2 required
networking.v1.AzureEgressPrivateLinkEndpoint
object
Azure Private Endpoint.
4 properties
2 required
networking.v1.AzureIngressPrivateLinkEndpoint
object
Azure Ingress Private Link Endpoint.
2 properties
2 required
networking.v1.GcpEgressPrivateServiceConnectEndpoint
object
GCP Private Service Connect Endpoint.
3 properties
2 required
networking.v1.GcpIngressPrivateServiceConnectEndpoint
object
GCP Ingress Private Service Connect Endpoint.
2 properties
2 required
networking.v1.AwsEgressPrivateLinkEndpointStatus
object
Status of an AWS PrivateLink Endpoint.
3 properties
3 required
networking.v1.AwsIngressPrivateLinkEndpointStatus
object
Status of an AWS Ingress Private Link Endpoint.
4 properties
3 required
networking.v1.AzureEgressPrivateLinkEndpointStatus
object
Status of an Azure Private Endpoint.
5 properties
3 required
networking.v1.AzureIngressPrivateLinkEndpointStatus
object
Status of an Azure Ingress Private Link Endpoint.
5 properties
4 required
networking.v1.GcpEgressPrivateServiceConnectEndpointStatus
object
Status of a GCP Private Service Connect Endpoint.
4 properties
4 required
networking.v1.GcpIngressPrivateServiceConnectEndpointStatus
object
Status of a GCP Ingress Private Service Connect Endpoint.
4 properties
3 required
networking.v1.PrivateLinkAccessPoint
object
DNS record that is associated with a PrivateLink access point.
2 properties
2 required
networking.v1.AwsPrivateNetworkInterface
object
Confluent Private Network Interface powered by AWS ENI.
4 properties
1 required
networking.v1.AccessPointList
object
AccessPoint objects represent network connections in and out of Gateways. This API allows you to list, create, read, update, and delete your access points. The…
4 properties
4 required
networking.v1.AccessPointSpec
object
The desired state of the Access Point
4 properties
networking.v1.DnsRecordList
object
DNS record objects are associated with Confluent Cloud networking resources. This API allows you to list, create, read, update, and delete your DNS records. Th…
4 properties
4 required
networking.v1.DnsRecordSpec
object
The desired state of the Dns Record
5 properties
iam.v2.CertificateAuthority
object
CertificateAuthority objects represent signing certificate authorities in Confluent Cloud. The API allows you to list, create, read, update, and delete your Ce…
15 properties
iam.v2.CertificateIdentityPool
object
Identitypool objects represent workload identities in Confluent Cloud. The API allows you to list, create, read, update, and delete your identity pools associa…
10 properties
iam.v2.CreateCertRequest
object
This contains the json schema used to create a Certificate Authority
11 properties
iam.v2.UpdateCertRequest
object
This contains the form fields used to update a Certificate Authority
11 properties
iam.v2.CertificateAuthorityList
object
CertificateAuthority objects represent signing certificate authorities in Confluent Cloud. The API allows you to list, create, read, update, and delete your Ce…
4 properties
4 required
iam.v2.CertificateIdentityPoolList
object
Identitypool objects represent workload identities in Confluent Cloud. The API allows you to list, create, read, update, and delete your identity pools associa…
4 properties
4 required
pim.v1.Integration
object
Provider Integration objects represent access to public cloud service provider (CSP) resources that may be accessed by Confluent resources (for example, connec…
8 properties
pim.v1.AwsIntegrationConfig
object
config schema for AWS cloud service provider.
4 properties
1 required
pim.v1.IntegrationList
object
Provider Integration objects represent access to public cloud service provider (CSP) resources that may be accessed by Confluent resources (for example, connec…
4 properties
4 required
pim.v2.Integration
object
Provider Integration objects represent access to public cloud service provider (CSP) resources that may be accessed by Confluent resources (for example, connec…
9 properties
pim.v2.GcpIntegrationConfig
object
config schema for GCP cloud service provider.
3 properties
1 required
pim.v2.AzureIntegrationConfig
object
config schema for Azure cloud service provider.
3 properties
1 required
pim.v2.AwsIntegrationConfig
object
config schema for AWS cloud service provider.
4 properties
1 required
pim.v2.IntegrationValidateRequest
object
Request to validate the provider integration configuration.
6 properties
pim.v2.IntegrationList
object
Provider Integration objects represent access to public cloud service provider (CSP) resources that may be accessed by Confluent resources (for example, connec…
4 properties
4 required
artifact.v1.FlinkArtifact
object
FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. The Flink Artifacts Model
14 properties
artifact.v1.PresignedUrl
object
Request a presigned upload URL for new Flink Artifact. Note that the URL policy expires in one hour. If the policy expires, you can request a new presigned upl…
9 properties
artifact.v1.FlinkArtifactVersion
object
Version of the Flink Artifact
5 properties
3 required
artifact.v1.PresignedUrlRequest
object
Request schema of the presigned upload URL.
8 properties
artifact.v1.UploadSource.PresignedUrl
object
Request a presigned upload URL for new Flink Artifact. Note that the URL policy expires in one hour. If the policy expires, you can request a new presigned upl…
6 properties
artifact.v1.FlinkArtifactList
object
FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. The Flink Artifacts Model
4 properties
4 required
networking.v1.Gateway
object
A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. The Gateways Model Quotas and Limits This resource is subject to…
6 properties
networking.v1.GatewayStatus
object
The status of the Gateway
4 properties
1 required
networking.v1.AwsPrivateNetworkInterfaceGatewaySpec
object
AWS Private Network Interface Gateway details from AWS.
3 properties
3 required
networking.v1.AwsPeeringGatewaySpec
object
AWS Peering Gateway details from AWS.
2 properties
2 required
networking.v1.AzurePeeringGatewaySpec
object
Azure Peering Gateway details from Azure.
2 properties
2 required
networking.v1.AwsEgressPrivateLinkGatewaySpec
object
AWS Egress Private Link Gateway details from AWS.
2 properties
2 required
networking.v1.AwsIngressPrivateLinkGatewaySpec
object
AWS Ingress Private Link Gateway details from AWS.
2 properties
2 required
networking.v1.AzureEgressPrivateLinkGatewaySpec
object
Azure Egress Private Link Gateway details from Azure.
2 properties
2 required
networking.v1.AzureIngressPrivateLinkGatewaySpec
object
Azure Ingress Private Link Gateway details from Azure.
2 properties
2 required
networking.v1.GcpPeeringGatewaySpec
object
GCP Peering Gateway details.
2 properties
2 required
networking.v1.GcpEgressPrivateServiceConnectGatewaySpec
object
GCP Private Service Connect Gateway details from GCP.
2 properties
2 required
networking.v1.GcpIngressPrivateServiceConnectGatewaySpec
object
GCP Ingress Private Service Connect Gateway details from GCP.
2 properties
2 required
networking.v1.AwsPrivateNetworkInterfaceGatewayStatus
object
AWS Private Network Interface Gateway details from AWS.
2 properties
1 required
networking.v1.AwsEgressPrivateLinkGatewayStatus
object
AWS Egress Private Link Gateway details from AWS.
2 properties
1 required
networking.v1.AwsIngressPrivateLinkGatewayStatus
object
AWS Ingress Private Link Gateway details from AWS.
2 properties
1 required
networking.v1.AzureEgressPrivateLinkGatewayStatus
object
Azure Egress Private Link Gateway details from Azure.
2 properties
1 required
networking.v1.AzureIngressPrivateLinkGatewayStatus
object
Azure Ingress Private Link Gateway details from Azure.
3 properties
1 required
networking.v1.GcpPeeringGatewayStatus
object
GCP Peering Gateway details from GCP.
2 properties
1 required
networking.v1.GcpEgressPrivateServiceConnectGatewayStatus
object
GCP Private Service Connect Gateway details from GCP.
2 properties
1 required
networking.v1.GcpIngressPrivateServiceConnectGatewayStatus
object
GCP Ingress Private Service Connect Gateway details from GCP.
2 properties
1 required
networking.v1.GatewayList
object
A Gateway represents a slice of traffic capacity in a region that is reserved for a customer. The Gateways Model Quotas and Limits This resource is subject to…
4 properties
4 required
networking.v1.GatewaySpec
object
The desired state of the Gateway
3 properties
ccl.v1.CustomCodeLogging
object
CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. The API allows you to list, create, read, update, and delete your Custom Code Loggi…
8 properties
ccl.v1.KafkaDestinationSettings
object
Kafka Destination Settings of the Custom Code Logging.
4 properties
3 required
ccl.v1.CustomCodeLoggingList
object
CustomCodeLogging objects represent Custom Code Logging on Confluent Cloud. The API allows you to list, create, read, update, and delete your Custom Code Loggi…
4 properties
4 required
tableflow.v1.Region
object
Region objects represent cloud provider regions where Tableflow can be enabled. This API allows you to list all supported Tableflow regions. The Regions Model
6 properties
tableflow.v1.TableflowTopic
object
A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic The Tableflow Topics Model
5 properties
tableflow.v1.TableflowTopicStatus
object
The status of the Tableflow Topic
5 properties
1 required
tableflow.v1.CatalogIntegration
object
A Catalog Integration represents configuration related to a catalog integration The Catalog Integrations Model
6 properties
tableflow.v1.CatalogIntegrationStatus
object
The status of the Catalog Integration
3 properties
tableflow.v1.TableFlowTopicConfigsSpec
object
The configs for the Tableflow enabled topic
6 properties
tableflow.v1.ByobAwsSpec
object
The Tableflow storage config for BYOB enabled topic in AWS
5 properties
3 required
tableflow.v1.ManagedStorageSpec
object
The storage config for confluent managed Tableflow enabled topic.
2 properties
1 required
tableflow.v1.AzureAdlsSpec
object
The Tableflow storage config for customer-owned Azure Data Lake Storage Gen2
6 properties
4 required
tableflow.v1.CatalogIntegrationAwsGlueSpec
object
The catalog integration Glue connection config.
3 properties
2 required
tableflow.v1.CatalogIntegrationSnowflakeSpec
object
The catalog integration connection config for Snowflake Open Catalog.
7 properties
6 required
tableflow.v1.CatalogIntegrationUnitySpec
object
The catalog integration connection config for Unity Catalog.
6 properties
5 required
tableflow.v1.CatalogIntegrationSnowflakeUpdateSpec
object
The catalog integration connection config for Snowflake Open Catalog (update operations).
7 properties
1 required
tableflow.v1.CatalogIntegrationAwsGlueUpdateSpec
object
The catalog integration Glue connection config for update operations.
2 properties
1 required
tableflow.v1.CatalogIntegrationUnityUpdateSpec
object
The catalog integration connection config for Unity Catalog.
6 properties
1 required
tableflow.v1.CatalogIntegrationUpdateRequest
object
The desired state of the Catalog Integration
5 properties
tableflow.v1.CatalogIntegrationUpdateSpec
object
The desired state of the Catalog Integration
5 properties
2 required
tableflow.v1.ErrorHandlingSuspend
object
Configuration for the SUSPEND error handling mode.
1 property
1 required
tableflow.v1.ErrorHandlingSkip
object
Configuration for the SKIP error handling mode.
1 property
1 required
tableflow.v1.ErrorHandlingLog
object
Configuration for the LOG error handling mode.
2 properties
1 required
tableflow.v1.CatalogSyncStatus
object
The synchronization status of an external catalog for a Tableflow topic
4 properties
tableflow.v1.RegionList
object
Region objects represent cloud provider regions where Tableflow can be enabled. This API allows you to list all supported Tableflow regions. The Regions Model
4 properties
4 required
tableflow.v1.TableflowTopicList
object
A Tableflow Topic represents configuration related to a Tableflow enabled kafka topic The Tableflow Topics Model
4 properties
4 required
tableflow.v1.TableflowTopicSpec
object
The desired state of the Tableflow Topic
7 properties
tableflow.v1.CatalogIntegrationList
object
A Catalog Integration represents configuration related to a catalog integration The Catalog Integrations Model
4 properties
4 required
tableflow.v1.CatalogIntegrationSpec
object
The desired state of the Catalog Integration
5 properties
ccpm.v1.CustomConnectPlugin
object
CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent Cloud. The API allows you to list, create, read…
5 properties
ccpm.v1.PresignedUrl
object
Request a presigned upload URL for new Custom Connect Plugin. Note that the URL policy expires in one hour. If the policy expires, you can request a new presig…
8 properties
ccpm.v1.CustomConnectPluginVersion
object
CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. The API allows you to list, create, read, update, and delete yo…
6 properties
ccpm.v1.CustomConnectPluginVersionStatus
object
The status of the Custom Connect Plugin Version
2 properties
1 required
ccpm.v1.ConnectorClass
object
Java class of the Connector.
2 properties
2 required
ccpm.v1.UploadSource.PresignedUrl
object
Presigned URL of the uploaded Custom Connect Plugin archive.
2 properties
2 required
ccpm.v1.CustomConnectPluginList
object
CustomConnectPlugins objects represent Custom Connect artifacts containing connector, and SMT jars on Confluent Cloud. The API allows you to list, create, read…
4 properties
4 required
ccpm.v1.CustomConnectPluginSpec
object
The desired state of the Custom Connect Plugin
5 properties
ccpm.v1.CustomConnectPluginVersionList
object
CustomConnectPluginVersion objects represent Custom Connect Plugin Versions on Confluent Cloud. The API allows you to list, create, read, update, and delete yo…
4 properties
4 required
ccpm.v1.CustomConnectPluginVersionSpec
object
The desired state of the Custom Connect Plugin Version
7 properties
usm.v1.KafkaCluster
object
KafkaCluster object represent Confluent Platform Kafka clusters registered with Confluent Cloud. The API allows you to create and delete KafkaCluster. The Kafk…
8 properties
usm.v1.ConnectCluster
object
ConnectCluster object represent Confluent Platform Connect clusters registered with Confluent Cloud. The API allows you to create and delete ConnectCluster. Th…
9 properties
usm.v1.KafkaClusterList
object
KafkaCluster object represent Confluent Platform Kafka clusters registered with Confluent Cloud. The API allows you to create and delete KafkaCluster. The Kafk…
4 properties
4 required
usm.v1.ConnectClusterList
object
ConnectCluster object represent Confluent Platform Connect clusters registered with Confluent Cloud. The API allows you to create and delete ConnectCluster. Th…
4 properties
4 required
endpoint.v1.Endpoint
object
An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource via a specific networking solution for a given Confluent Cl…
15 properties
endpoint.v1.EndpointList
object
An Endpoint object represents a Fully Qualified Domain Name (FQDN) for a Confluent service resource via a specific networking solution for a given Confluent Cl…
4 properties
4 required
rtce.v1.RtceTopic
object
An RtceTopic represents a customer's Kafka topic enabled for real-time context engine capabilities, providing low-latency data access and lookups. The Rtce Top…
5 properties
rtce.v1.RtceTopicStatus
object
The status of the Rtce Topic
2 properties
1 required
rtce.v1.Region
object
Region objects represent cloud provider regions where RtceTopics can be deployed. This API allows you to list all supported RTCE regions. The Regions Model
7 properties
rtce.v1.RtceTopicList
object
An RtceTopic represents a customer's Kafka topic enabled for real-time context engine capabilities, providing low-latency data access and lookups. The Rtce Top…
4 properties
4 required
rtce.v1.RtceTopicSpec
object
The desired state of the Rtce Topic
6 properties
rtce.v1.RegionList
object
Region objects represent cloud provider regions where RtceTopics can be deployed. This API allows you to list all supported RTCE regions. The Regions Model
4 properties
4 required
query.v1alpha1.QueryRequest
object
Request parameters for query analysis and extraction.
5 properties
3 required
query.v1alpha1.QueryOptions
object
Settings that tune how this query is handled. Omitted fields fall back to service defaults.
2 properties
query.v1alpha1.QueryResponseInline
object
Response structure returned directly for fast inline extractions.
3 properties
3 required
query.v1alpha1.QueryResponseAsync
object
Reference pointers issued when standard executions run asynchronously.
2 properties
2 required
query.v1alpha1.JobStatusResponse
object
Lifecycle state of a statement running in the background.
2 properties
1 required
query.v1alpha1.JobStatus
object
The status of the background statement.
1 property
1 required
query.v1alpha1.QueryResult
object
Query result containing schema metadata and row data. This envelope is the same for every statement kind. SHOW and DESCRIBE return declared column types in sch…
3 properties
3 required
query.v1alpha1.ResultSchema
object
The table columns of the result schema.
1 property
1 required
query.v1alpha1.ColumnDetails
object
A column in the result schema.
2 properties
2 required
query.v1alpha1.DataType
object
Flink logical type descriptor, mirroring DataType in the Flink Gateway API. Complex types nest recursively: elementType, keyType, valueType and fields[].fieldT…
12 properties
2 required
query.v1alpha1.RowFieldType
object
One field of a ROW. Field names are carried here, in the schema only — never inline with the row values.
3 properties
2 required
query.v1alpha1.ResultRow
array
A single result row — column values ordered to match schema.columns. Rows carry no changelog operation marker: this API returns a point-in-time snapshot rather…
query.v1alpha1.ResultValue
One value within a JSON result row. Scalar values are JSON strings encoded according to the declaring column's DataType.type. JSON null is SQL NULL, at any dep…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Confluent | the Data Streaming Platform 10
Other APIs Confluent | the Data Streaming Platform publishes across the network.
Confluent Kafka REST API
Confluent Schema Registry REST API
Kafka Connect REST API
ksqlDB REST API
Confluent Cloud for Apache Flink REST API
Confluent | the Data Streaming Platform API Keys API
Confluent | the Data Streaming Platform Clusters API
Confluent | the Data Streaming Platform Environments API
Confluent | the Data Streaming Platform Organizations API
Confluent | the Data Streaming Platform Service Accounts API
#Confluent Cloud#Management#REST
Where this information came from
This is an independent, third-party profile of Confluent Cloud REST 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.