Skip to main content

List schemas

GET 
/schemas

Get the schemas matching the specified parameters.

Request​

Responses​

List of schemas matching the specified parameters.

OpenAPI definition (YAML) 
paths:
  /schemas:
    get:
      tags:
      - Schemas (v1)
      description: Get the schemas matching the specified parameters.
      operationId: getSchemas
      parameters:
      - name: subjectPrefix
        in: query
        description: Filters results by the respective subject prefix
        schema:
          type: string
          default: ''
      - name: aliases
        in: query
        description: Whether to include aliases in the search
        schema:
          type: boolean
          default: false
      - name: deleted
        in: query
        description: Whether to return soft deleted schemas
        schema:
          type: boolean
          default: false
      - name: latestOnly
        in: query
        description: Whether to return latest schema versions only for each matching subject
        schema:
          type: boolean
          default: false
      - name: ruleType
        in: query
        description: Filters results by the given rule type
        schema:
          type: string
          default: ''
      - name: offset
        in: query
        description: Pagination offset for results
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Pagination size for results. Ignored if negative
        schema:
          type: integer
          format: int32
          default: -1
      responses:
        '200':
          description: List of schemas matching the specified parameters.
          content:
            application/vnd.schemaregistry.v1+json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    subject:
                      type: string
                      description: Name of the subject
                      example: User
                    version:
                      type: integer
                      description: Version number
                      format: int32
                      example: 1
                    id:
                      type: integer
                      description: Globally unique identifier of the schema
                      format: int32
                      example: 100001
                    schemaType:
                      type: string
                      description: Schema type
                      example: AVRO
                    references:
                      type: array
                      description: References to other schemas
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Reference name
                            example: io.confluent.kafka.example.User
                          subject:
                            type: string
                            description: Name of the referenced subject
                            example: User
                          version:
                            type: integer
                            description: Version number of the referenced subject
                            format: int32
                            example: 1
                        description: Schema reference
                        title: SchemaReference
                    schema:
                      type: string
                      description: Schema definition string
                      example: '{"schema": "{"type": "string"}"}'
                    metadata:
                      description: User-defined metadata
                      nullable: true
                      properties:
                        tags:
                          additionalProperties:
                            items:
                              type: string
                            type: array
                            uniqueItems: true
                          type: object
                        properties:
                          additionalProperties:
                            type: string
                          type: object
                        sensitive:
                          items:
                            type: string
                          type: array
                          uniqueItems: true
                      type: object
                      title: Metadata
                    ruleSet:
                      description: Schema rule set
                      nullable: true
                      properties:
                        migrationRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                        domainRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                      type: object
                      title: RuleSet
                    schemaTags:
                      type: array
                      description: Schema tags
                      items:
                        type: object
                        properties:
                          schemaEntity:
                            type: object
                            properties:
                              entityPath:
                                type: string
                              entityType:
                                type: string
                                enum:
                                - sr_record
                                - sr_field
                            title: SchemaEntity
                          tags:
                            type: array
                            items:
                              type: string
                        title: SchemaTags
                  description: Schema
                  title: Schema
            application/vnd.schemaregistry+json; qs=0.9:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    subject:
                      type: string
                      description: Name of the subject
                      example: User
                    version:
                      type: integer
                      description: Version number
                      format: int32
                      example: 1
                    id:
                      type: integer
                      description: Globally unique identifier of the schema
                      format: int32
                      example: 100001
                    schemaType:
                      type: string
                      description: Schema type
                      example: AVRO
                    references:
                      type: array
                      description: References to other schemas
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Reference name
                            example: io.confluent.kafka.example.User
                          subject:
                            type: string
                            description: Name of the referenced subject
                            example: User
                          version:
                            type: integer
                            description: Version number of the referenced subject
                            format: int32
                            example: 1
                        description: Schema reference
                        title: SchemaReference
                    schema:
                      type: string
                      description: Schema definition string
                      example: '{"schema": "{"type": "string"}"}'
                    metadata:
                      description: User-defined metadata
                      nullable: true
                      properties:
                        tags:
                          additionalProperties:
                            items:
                              type: string
                            type: array
                            uniqueItems: true
                          type: object
                        properties:
                          additionalProperties:
                            type: string
                          type: object
                        sensitive:
                          items:
                            type: string
                          type: array
                          uniqueItems: true
                      type: object
                      title: Metadata
                    ruleSet:
                      description: Schema rule set
                      nullable: true
                      properties:
                        migrationRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                        domainRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                      type: object
                      title: RuleSet
                    schemaTags:
                      type: array
                      description: Schema tags
                      items:
                        type: object
                        properties:
                          schemaEntity:
                            type: object
                            properties:
                              entityPath:
                                type: string
                              entityType:
                                type: string
                                enum:
                                - sr_record
                                - sr_field
                            title: SchemaEntity
                          tags:
                            type: array
                            items:
                              type: string
                        title: SchemaTags
                  description: Schema
                  title: Schema
            application/json; qs=0.5:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    subject:
                      type: string
                      description: Name of the subject
                      example: User
                    version:
                      type: integer
                      description: Version number
                      format: int32
                      example: 1
                    id:
                      type: integer
                      description: Globally unique identifier of the schema
                      format: int32
                      example: 100001
                    schemaType:
                      type: string
                      description: Schema type
                      example: AVRO
                    references:
                      type: array
                      description: References to other schemas
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            description: Reference name
                            example: io.confluent.kafka.example.User
                          subject:
                            type: string
                            description: Name of the referenced subject
                            example: User
                          version:
                            type: integer
                            description: Version number of the referenced subject
                            format: int32
                            example: 1
                        description: Schema reference
                        title: SchemaReference
                    schema:
                      type: string
                      description: Schema definition string
                      example: '{"schema": "{"type": "string"}"}'
                    metadata:
                      description: User-defined metadata
                      nullable: true
                      properties:
                        tags:
                          additionalProperties:
                            items:
                              type: string
                            type: array
                            uniqueItems: true
                          type: object
                        properties:
                          additionalProperties:
                            type: string
                          type: object
                        sensitive:
                          items:
                            type: string
                          type: array
                          uniqueItems: true
                      type: object
                      title: Metadata
                    ruleSet:
                      description: Schema rule set
                      nullable: true
                      properties:
                        migrationRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                        domainRules:
                          items:
                            description: Rule
                            properties:
                              name:
                                description: Rule name
                                type: string
                              doc:
                                description: Rule doc
                                type: string
                              kind:
                                description: Rule kind
                                enum:
                                - TRANSFORM
                                - CONDITION
                                type: string
                              mode:
                                description: Rule mode
                                enum:
                                - UPGRADE
                                - DOWNGRADE
                                - UPDOWN
                                - WRITE
                                - READ
                                - WRITEREAD
                                type: string
                              type:
                                description: Rule type
                                type: string
                              tags:
                                description: The tags to which this rule applies
                                items:
                                  description: The tags to which this rule applies
                                  type: string
                                type: array
                                uniqueItems: true
                              params:
                                additionalProperties:
                                  description: Optional params for the rule
                                  type: string
                                description: Optional params for the rule
                                type: object
                              expr:
                                description: Rule expression
                                type: string
                              onSuccess:
                                description: Rule action on success
                                type: string
                              onFailure:
                                description: Rule action on failure
                                type: string
                              disabled:
                                description: Whether the rule is disabled
                                type: boolean
                            type: object
                            title: Rule
                          type: array
                      type: object
                      title: RuleSet
                    schemaTags:
                      type: array
                      description: Schema tags
                      items:
                        type: object
                        properties:
                          schemaEntity:
                            type: object
                            properties:
                              entityPath:
                                type: string
                              entityType:
                                type: string
                                enum:
                                - sr_record
                                - sr_field
                            title: SchemaEntity
                          tags:
                            type: array
                            items:
                              type: string
                        title: SchemaTags
                  description: Schema
                  title: Schema
        '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
        '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.