Skip to main content

Get subject compatibility level

GET 
/config/:subject

Retrieves compatibility level, compatibility group, normalization, default metadata, and rule set for a subject.

Request​

Responses​

The subject compatibility level.

OpenAPI definition (YAML) 
paths:
  /config/{subject}:
    get:
      tags:
      - Config (v1)
      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:
                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
                    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
                title: Config
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                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
                    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
                title: Config
            application/json; qs=0.5:
              schema:
                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
                    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
                title: Config
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                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
                title: ErrorMessage
              example:
                error_code: 400
                message: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                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
                title: ErrorMessage
              example:
                error_code: 401
                message: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                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
                title: ErrorMessage
              example:
                error_code: 403
                message: Forbidden
        '404':
          description: Not Found. Error code 40401 indicates subject not found.
          content:
            application/vnd.schemaregistry.v1+json:
              schema:
                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
                title: ErrorMessage
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                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
                title: ErrorMessage
            application/json; qs=0.5:
              schema:
                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
                title: ErrorMessage
        '429':
          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.
        '500':
          description: Internal Server Error. Error code 50001 indicates a failure in the backend data
            store.
          content:
            application/vnd.schemaregistry.v1+json:
              schema:
                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
                title: ErrorMessage
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                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
                title: ErrorMessage
            application/json; qs=0.5:
              schema:
                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
                title: ErrorMessage
      security:
      - resource-api-key: []
      - external-access-token: []
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint.