openapi: 3.2.0 info: title: Confluent Cloud Config (v1) API version: '' x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b x-audience: external-public x-logo: url: https://assets.confluent.io/m/1661ef5e4ff82d3d/ description: '# Introduction Note This documents the collection of Confluent Cloud APIs.' servers: - url: https://api.confluent.cloud description: Confluent Cloud API tags: - name: Config (v1) description: '![Generally Available](#section/Versioning/API-Lifecycle-Policy) The API allows you to manage and query schema compatibility settings and cluster configurations. Related guide: Manage Schemas in Confluent Cloud.' paths: /clusterconfig: servers: - url: https://psrc-00000.region.provider.confluent.cloud description: Confluent Cloud Schema Registry Endpoint. get: tags: - Config (v1) summary: Get cluster config description: Retrieves cluster config information. operationId: getClusterConfig responses: '200': description: The cluster config content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ClusterConfig' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ClusterConfig' application/json; qs=0.5: schema: $ref: '#/components/schemas/ClusterConfig' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' '500': $ref: '#/components/responses/schemaregistry.v1.DefaultSystemError' security: - resource-api-key: [] - external-access-token: [] /config/{subject}: servers: - url: https://psrc-00000.region.provider.confluent.cloud description: Confluent Cloud Schema Registry Endpoint. get: tags: - Config (v1) summary: Get subject compatibility level description: 'Retrieves compatibility level, compatibility group, normalization, default metadata, and rule set for a subject.' operationId: getSubjectLevelConfig parameters: - name: subject in: path description: Name of the subject required: true schema: type: string - name: defaultToGlobal in: query description: Whether to return the global compatibility level if subject compatibility level not found schema: type: boolean responses: '200': description: The subject compatibility level. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/Config' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/Config' application/json; qs=0.5: schema: $ref: '#/components/schemas/Config' '404': description: Not Found. Error code 40401 indicates subject not found. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] put: tags: - Config (v1) summary: Update subject compatibility level description: 'Update compatibility level, compatibility group, normalization, default metadata, and rule set for the specified subject. On success, echoes the original request back to the client.' operationId: updateSubjectLevelConfig parameters: - name: subject in: path description: Name of the subject required: true schema: type: string requestBody: description: Config Update Request content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/vnd.schemaregistry+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/octet-stream: schema: $ref: '#/components/schemas/ConfigUpdateRequest' required: true responses: '200': description: The original request. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/json; qs=0.5: schema: $ref: '#/components/schemas/ConfigUpdateRequest' '422': description: Unprocessable Entity. Error code 42203 indicates invalid compatibility level. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] delete: tags: - Config (v1) summary: Delete subject compatibility level description: Deletes the specified subject-level compatibility level config and reverts to the global default. operationId: deleteSubjectConfig parameters: - name: subject in: path description: Name of the subject required: true schema: type: string responses: '200': description: Operation succeeded. Returns old compatibility level. content: application/vnd.schemaregistry.v1+json: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE application/vnd.schemaregistry+json; qs=0.9: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE application/json; qs=0.5: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE '404': description: Not Found. Error code 40401 indicates subject not found. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] /config: servers: - url: https://psrc-00000.region.provider.confluent.cloud description: Confluent Cloud Schema Registry Endpoint. get: tags: - Config (v1) summary: Get global compatibility level description: 'Retrieves the global compatibility level, compatibility group, normalization, default metadata, and rule set.' operationId: getTopLevelConfig responses: '200': description: The global compatibility level. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/Config' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/Config' application/json; qs=0.5: schema: $ref: '#/components/schemas/Config' '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] put: tags: - Config (v1) summary: Update global compatibility level description: 'Updates the global compatibility level, compatibility group, schema normalization, default metadata, and rule set. On success, echoes the original request back to the client.' operationId: updateTopLevelConfig requestBody: description: Config Update Request content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/vnd.schemaregistry+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/octet-stream: schema: $ref: '#/components/schemas/ConfigUpdateRequest' required: true responses: '200': description: The original request. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ConfigUpdateRequest' application/json; qs=0.5: schema: $ref: '#/components/schemas/ConfigUpdateRequest' '422': description: Unprocessable Entity. Error code 42203 indicates invalid compatibility level. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. Error code 50003 indicates a failure forwarding the request to the primary. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] delete: tags: - Config (v1) summary: Delete global compatibility level description: Deletes the global compatibility level config and reverts to the default. operationId: deleteTopLevelConfig responses: '200': description: Operation succeeded. Returns old global compatibility level. content: application/vnd.schemaregistry.v1+json: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE application/vnd.schemaregistry+json; qs=0.9: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE application/json; qs=0.5: schema: type: string x-extensible-enum: - NONE - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE example: FULL_TRANSITIVE '500': description: Internal Server Error. Error code 50001 indicates a failure in the backend data store. content: application/vnd.schemaregistry.v1+json: schema: $ref: '#/components/schemas/ErrorMessage' application/vnd.schemaregistry+json; qs=0.9: schema: $ref: '#/components/schemas/ErrorMessage' application/json; qs=0.5: schema: $ref: '#/components/schemas/ErrorMessage' '400': $ref: '#/components/responses/schemaregistry.v1.BadRequestError' '401': $ref: '#/components/responses/schemaregistry.v1.UnauthorizedError' '403': $ref: '#/components/responses/schemaregistry.v1.ForbiddenError' '429': $ref: '#/components/responses/RateLimitError' security: - resource-api-key: [] - external-access-token: [] components: responses: schemaregistry.v1.ForbiddenError: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' example: error_code: 403 message: Forbidden schemaregistry.v1.UnauthorizedError: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' example: error_code: 401 message: Unauthorized schemaregistry.v1.DefaultSystemError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' example: error_code: 500 message: Oops, something went wrong RateLimitError: description: Rate Limit Exceeded headers: X-Request-Id: schema: type: string description: The unique identifier for the API request. X-RateLimit-Limit: schema: type: integer description: The maximum number of requests you're permitted to make per time period. X-RateLimit-Remaining: schema: type: integer description: The number of requests remaining in the current rate limit window. X-RateLimit-Reset: schema: type: integer description: "The relative time in seconds until the current rate-limit window resets. \n \n**Important:** This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues." Retry-After: schema: type: integer description: The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached. schemaregistry.v1.BadRequestError: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' example: error_code: 400 message: Bad Request schemas: Config: type: object properties: alias: type: string description: 'If alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias.' normalize: type: boolean description: 'If true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur.' compatibilityLevel: type: string description: Compatibility Level example: FULL_TRANSITIVE x-extensible-enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE compatibilityGroup: type: string description: 'Only schemas that belong to the same compatibility group will be checked for compatibility.' defaultMetadata: type: object description: Default value for the metadata to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values overrideMetadata: type: object description: Override value for the metadata to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values defaultRuleSet: type: object description: Default value for the ruleSet to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values overrideRuleSet: type: object description: Override value for the ruleSet to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values description: Config ClusterConfig: type: object properties: maxSchemas: type: integer description: Maximum number of registered schemas allowed format: int32 example: 20000 maxRequestsPerSec: type: integer description: Maximum number of allowed requests per second format: int32 example: 25 description: Cluster Config ConfigUpdateRequest: type: object properties: alias: type: string description: 'If alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias.' normalize: type: boolean description: 'If true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur.' compatibility: type: string description: Compatibility Level example: FULL_TRANSITIVE x-extensible-enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE compatibilityGroup: type: string description: 'Only schemas that belong to the same compatibility group will be checked for compatibility.' defaultMetadata: type: object description: Default value for the metadata to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values overrideMetadata: type: object description: Override value for the metadata to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values defaultRuleSet: type: object description: Default value for the ruleSet to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values overrideRuleSet: type: object description: Override value for the ruleSet to be used during schema registration. properties: properties: type: object description: The metadata properties and their new values description: Config update request ErrorMessage: type: object properties: error_code: type: integer description: The error code format: int32 message: type: string description: The error message description: Error message of this operation securitySchemes: cloud-api-key: type: http scheme: basic description: 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: type: oauth2 description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0. flows: clientCredentials: tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token scopes: {} global-api-key: type: http scheme: basic description: 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: type: http scheme: basic description: 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 as the password. external-access-token: type: oauth2 description: Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0. flows: clientCredentials: tokenUrl: https://api.confluent.cloud/sts/v1/oauth2/token scopes: {} oauth: type: oauth2 description: Authenticate with OAuth 2.0. Currently this is only supported for partner APIs. flows: clientCredentials: tokenUrl: /oauth2/token scopes: partner:alter: enables partners to alter entitlements partner:create: enables partners to create entitlements and signup on behalf of customers partner:delete: enables partners to delete entitlements and organizations partner:describe: enables partners to read and list entitlements and organizations x-tagGroups: - name: Identity Access Management (v2) tags: - API Keys (iam/v2) - Users (iam/v2) - Service Accounts (iam/v2) - Invitations (iam/v2) - IP Groups (iam/v2) - IP Filters (iam/v2) - IP Filter Summaries (iam/v2) - Role Bindings (iam/v2) - Identity Providers (iam/v2) - Jwks (iam/v2) - Identity Pools (iam/v2) - Group Mappings (iam/v2/sso) - Certificate Authorities (iam/v2) - Certificate Identity Pools (iam/v2) - name: Org API (v2) tags: - Environments (org/v2) - Organizations (org/v2) - name: Notifications API (v1) tags: - Subscriptions (notifications/v1) - Integrations (notifications/v1) - Notification Types (notifications/v1) - Resource Preferences (notifications/v1) - Resource Subscriptions (notifications/v1) - User Notifications (notifications/v1) - name: Cluster Mgmt for Kafka (v2) tags: - Clusters (cmk/v2) - name: Cluster Mgmt for ksqlDB (v2) tags: - Clusters (ksqldbcm/v2) - name: Connect API (v1) tags: - Connectors (connect/v1) - Lifecycle (connect/v1) - Status (connect/v1) - Managed Connector Plugins (connect/v1) - Offsets (connect/v1) - Custom Connector Plugins (connect/v1) - Presigned Urls (connect/v1) - Custom Connector Runtimes (connect/v1) - name: Connect Artifact Management (v1) tags: - Connect Artifacts (cam/v1) - Presigned Urls (cam/v1) - name: Kafka API (v3) tags: - Cluster (v3) - Configs (v3) - ACL (v3) - Consumer Group (v3) - Partition (v3) - Topic (v3) - Records (v3) - Cluster Linking (v3) - Share Group (v3) - Streams Group (v3) - name: Service Quota API (v1) tags: - Applied Quotas (service-quota/v1) - Scopes (service-quota/v1) - name: Partner API (v2) tags: - Entitlements (partner/v2) - Organizations (partner/v2) - Signup (partner/v2) - name: Cluster Mgmt for Schema Registry (v2) tags: - Regions (srcm/v2) - Clusters (srcm/v2) - name: Cluster Mgmt for Schema Registry (v3) tags: - Clusters (srcm/v3) - name: Schema Registry API (v1) tags: - Compatibility (v1) - Config (v1) - Contexts (v1) - Exporters (v1) - Modes (v1) - Schemas (v1) - Subjects (v1) - Key Encryption Keys (v1) - Data Encryption Keys (v1) - name: Catalog API (v1) tags: - Entity (v1) - Search (v1) - Types (v1) - name: Stream Sharing API (v1) tags: - Provider Shared Resources (cdx/v1) - Provider Shares (cdx/v1) - Consumer Shared Resources (cdx/v1) - Consumer Shares (cdx/v1) - Shared Tokens (cdx/v1) - Opt Ins (cdx/v1) - name: Networking (v1) tags: - Networks (networking/v1) - Peerings (networking/v1) - Transit Gateway Attachments (networking/v1) - Private Link Accesses (networking/v1) - Network Link Services (networking/v1) - Network Link Endpoints (networking/v1) - Network Link Service Associations (networking/v1) - IP Addresses (networking/v1) - Private Link Attachments (networking/v1) - Private Link Attachment Connections (networking/v1) - DNS Forwarders (networking/v1) - Access Points (networking/v1) - DNS Records (networking/v1) - Gateways (networking/v1) - name: Security Token Service (v1) tags: - OAuth Tokens (sts/v1) - name: Kafka Quota (v1) tags: - Client Quotas (kafka-quotas/v1) - name: Bring Your Own Key (BYOK) Management (v1) tags: - Keys (byok/v1) - name: Billing API (v1) tags: - Costs (billing/v1) - name: Compute Pool Mgmt for Flink (v2) tags: - Compute Pools (fcpm/v2) - Regions (fcpm/v2) - Org Compute Pool Configs (fcpm/v2) - name: SQL API (v1) tags: - Statements (sql/v1) - Statement Results (sql/v1) - Statement Exceptions (sql/v1) - Connections (sql/v1) - Agents (sql/v1) - Tools (sql/v1) - Materialized Tables (sql/v1) - Materialized Table Versions (sql/v1) - name: Provider Integration Management (v1) tags: - Integrations (pim/v1) - name: Provider Integration Management (v2) tags: - Integrations (pim/v2) - name: Artifact API (v1) tags: - Flink Artifacts (artifact/v1) - Presigned Urls (artifact/v1) - Flink Artifact Versions (artifact/v1) - name: Custom Code Logging API (v1) tags: - Custom Code Loggings (ccl/v1) - name: Tableflow (v1) tags: - Regions (tableflow/v1) - Tableflow Topics (tableflow/v1) - Catalog Integrations (tableflow/v1) - name: Custom Connect Plugin Management (v1) tags: - Custom Connect Plugins (ccpm/v1) - Presigned Urls (ccpm/v1) - Custom Connect Plugin Versions (ccpm/v1) - name: Unified Stream Manager (v1) tags: - Kafka Clusters (usm/v1) - Connect Clusters (usm/v1) - name: Endpoint (v1) tags: - Endpoints (endpoint/v1) - name: Real Time Context Engine (v1) tags: - Rtce Topics (rtce/v1) - Regions (rtce/v1) - name: Analytics (v1alpha1) tags: - Statements (query/v1alpha1)