Confluent Schema Registry

Confluent Schema Registry Compatibility API

The Compatibility API from Confluent Schema Registry — 3 operation(s) for compatibility.

GitHub OpenAPI

Operations 6

GET /config Get global compatibility level #
PUT /config Update global compatibility level #
GET /config/{subject} Get subject-level compatibility #
PUT /config/{subject} Update subject-level compatibility #
DELETE /config/{subject} Delete subject-level compatibility #
POST /compatibility/subjects/{subject}/versions/{version} Test schema compatibility #

Documentation

📖
Documentation
https://docs.confluent.io/platform/current/schema-registry/develop/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent-schema-registry/refs/heads/main/openapi/confluent-schema-registry-compatibility-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/confluent-schema-registry/refs/heads/main/json-schema/schema-registry-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/confluent-schema-registry/refs/heads/main/json-ld/confluent-schema-registry-context.jsonld
🔗
Spectral
https://raw.githubusercontent.com/api-evangelist/confluent-schema-registry/refs/heads/main/rules/confluent-schema-registry-rules.yml
🔗
GitHub
https://github.com/confluentinc/schema-registry
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/confluent-schema-registry/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluent-schema-registry-compatibility-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

confluent-schema-registry-compatibility-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Schema Registry Compatibility API
  description: The Confluent Schema Registry provides a RESTful interface for storing and retrieving Avro, JSON Schema, and Protobuf schemas. It stores a versioned history of all schemas based on a specified subject name strategy, provides multiple compatibility settings, and allows evolution of schemas according to configured compatibility settings.
  version: 7.6.0
  contact:
    name: Confluent
    url: https://www.confluent.io/
  license:
    name: Confluent Community License
    url: https://www.confluent.io/confluent-community-license/
servers:
- url: http://localhost:8081
  description: Default Schema Registry
tags:
- name: Compatibility
paths:
  /config:
    get:
      summary: Get global compatibility level
      operationId: getTopLevelConfig
      tags:
      - Compatibility
      responses:
        '200':
          description: Global compatibility level
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
    put:
      summary: Update global compatibility level
      operationId: updateTopLevelConfig
      tags:
      - Compatibility
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: Updated config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
  /config/{subject}:
    get:
      summary: Get subject-level compatibility
      operationId: getSubjectLevelConfig
      tags:
      - Compatibility
      parameters:
      - name: subject
        in: path
        required: true
        schema:
          type: string
      - name: defaultToGlobal
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Subject compatibility level
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Config'
    put:
      summary: Update subject-level compatibility
      operationId: updateSubjectLevelConfig
      tags:
      - Compatibility
      parameters:
      - name: subject
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Config'
      responses:
        '200':
          description: Updated config
    delete:
      summary: Delete subject-level compatibility
      operationId: deleteSubjectConfig
      tags:
      - Compatibility
      parameters:
      - name: subject
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Compatibility setting deleted
  /compatibility/subjects/{subject}/versions/{version}:
    post:
      summary: Test schema compatibility
      operationId: testCompatibility
      tags:
      - Compatibility
      parameters:
      - name: subject
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: verbose
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterSchemaRequest'
      responses:
        '200':
          description: Compatibility check result
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_compatible:
                    type: boolean
                  messages:
                    type: array
                    items:
                      type: string
components:
  schemas:
    RegisterSchemaRequest:
      type: object
      required:
      - schema
      properties:
        schema:
          type: string
          description: The schema string
        schemaType:
          type: string
          enum:
          - AVRO
          - JSON
          - PROTOBUF
          default: AVRO
          description: The schema type
        references:
          type: array
          description: References to other schemas
          items:
            type: object
            properties:
              name:
                type: string
              subject:
                type: string
              version:
                type: integer
    Config:
      type: object
      properties:
        compatibilityLevel:
          type: string
          enum:
          - BACKWARD
          - BACKWARD_TRANSITIVE
          - FORWARD
          - FORWARD_TRANSITIVE
          - FULL
          - FULL_TRANSITIVE
          - NONE