COconfluent
Subjects (v1)

Lookup schema under subject

Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name.

post/subjects/{subject}

Request

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

Path parameters

subjectstring required

Subject under which the schema will be registered

Query parameters

normalizeboolean

Whether to lookup the normalized schema

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 lookup deleted schemas

Request body

versioninteger

Version number

idinteger

Globally unique identifier of the schema

schemaTypestring

Schema type

schemastring

Schema definition string

propagateSchemaTagsboolean

Example request

{
  "references": [
    {
      "name": "io.confluent.kafka.example.User",
      "subject": "User",
      "version": 1
    }
  ]
}

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.