COconfluent
Subjects (v1)

Get schema by version

Retrieves a specific version of the schema registered under this subject.

get/subjects/{subject}/versions/{version}

Request

  • Base URL
    https://psrc-00000.region.provider.confluent.cloud
  • URL
    https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/versions/{version}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Path parameters

subjectstring required

Name of the subject

versionstring required

Version of the schema to be returned. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" returns the last registered schema under the specified subject. Note that there may be a new latest schema that gets registered right after this request is served.

Query parameters

formatstring

Desired output format, dependent on schema type. For AVRO schemas, valid values are: " " (default) or "resolved". For PROTOBUF schemas, valid values are: " " (default), "ignore_extensions", or "serialized" (The parameter does not apply to JSON schemas.)

deletedboolean

Whether to include deleted schema

Response

The schema.

subjectstring

Name of the subject

versioninteger

Version number

idinteger

Globally unique identifier of the schema

schemaTypestring

Schema type

schemastring

Schema definition string

Example response

{
  "subject": "User",
  "version": 1,
  "id": 100001,
  "schemaType": "AVRO",
  "references": [
    {
      "name": "io.confluent.kafka.example.User",
      "subject": "User",
      "version": 1
    }
  ],
  "schema": "{\"schema\": \"{\"type\": \"string\"}\"}"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.