Subjects (v1)

Retrieve the latest version with the given metadata.

Retrieve the latest version with the given metadata.

get/subjects/{subject}/metadata

Request

  • Base URL
    https://psrc-00000.region.provider.confluent.cloud
  • URL
    https://psrc-00000.region.provider.confluent.cloud/subjects/{subject}/metadata
  • 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

keystring

The metadata key. Add "?key=key" at the end of the request to match a metadata key. This query parameter can appear multiple times. Each instance is matched with a corresponding value query parameter, in order.

valuestring

The metadata value. Add "?value=value" at the end of the request to match a metadata value. This query parameter can appear multiple times. Each instance is matched with a corresponding key query parameter, in order.

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

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.