Check if a schema is already registered for the subject.

POST /subjects/{subject}

Path parameters

subject string Required

The subject name. Use [:.:] for context-qualified subjects, or just for the default context.

Query parameters

normalize boolean
deleted boolean
format string

Redpanda version 25.2 or later. For Avro and Protobuf schemas only. Supported values: an empty string '' returns the schema in its current format (default), and serialized (Protobuf only) returns the schema in its Base64-encoded wire binary format. Unsupported values return a 501 error.

Body

schema string
schemaType string
references array[object]
Hide references attributes Show references attributes object
- name string
  
  The name used to reference this schema in the dependent schema definition.
- subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
- version integer
  
  The version of the referenced schema.
metadata object

A map of user-defined properties associated with this schema
Hide metadata attribute Show metadata attribute object
- properties object
  
  Accepted values may be string, number, or boolean. All values are converted to strings.
  Hide properties attribute Show properties attribute object
  
  * string Additional properties

Body

schema string
schemaType string
references array[object]
Hide references attributes Show references attributes object
- name string
  
  The name used to reference this schema in the dependent schema definition.
- subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
- version integer
  
  The version of the referenced schema.
metadata object

A map of user-defined properties associated with this schema
Hide metadata attribute Show metadata attribute object
- properties object
  
  Accepted values may be string, number, or boolean. All values are converted to strings.
  Hide properties attribute Show properties attribute object
  
  * string Additional properties

Body

schema string
schemaType string
references array[object]
Hide references attributes Show references attributes object
- name string
  
  The name used to reference this schema in the dependent schema definition.
- subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
- version integer
  
  The version of the referenced schema.
metadata object

A map of user-defined properties associated with this schema
Hide metadata attribute Show metadata attribute object
- properties object
  
  Accepted values may be string, number, or boolean. All values are converted to strings.
  Hide properties attribute Show properties attribute object
  
  * string Additional properties

Responses

200

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

OK
Hide response attributes Show response attributes object
- subject string
- version integer
- id integer
- schemaType string
- references array[object]
  
  Hide references attributes Show references attributes object
  
  name string
  
  The name used to reference this schema in the dependent schema definition.
  
  subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
  
  version integer
  
  The version of the referenced schema.
- metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  properties object
  
  Hide properties attribute Show properties attribute object
  
  * string Additional properties
- schema string
Hide response attributes Show response attributes object
- subject string
- version integer
- id integer
- schemaType string
- references array[object]
  
  Hide references attributes Show references attributes object
  
  name string
  
  The name used to reference this schema in the dependent schema definition.
  
  subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
  
  version integer
  
  The version of the referenced schema.
- metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  properties object
  
  Hide properties attribute Show properties attribute object
  
  * string Additional properties
- schema string
Hide response attributes Show response attributes object
- subject string
- version integer
- id integer
- schemaType string
- references array[object]
  
  Hide references attributes Show references attributes object
  
  name string
  
  The name used to reference this schema in the dependent schema definition.
  
  subject string
  
  The subject name of the referenced schema. Use [:.:] for context-qualified subjects, or just for the default context.
  
  version integer
  
  The version of the referenced schema.
- metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  properties object
  
  Hide properties attribute Show properties attribute object
  
  * string Additional properties
- schema string
404

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

Not Found
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
409

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

Incompatible schema
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
422

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

Invalid schema
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
500

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

Internal Server Error
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
501

application/vnd.schemaregistry.v1+json

application/vnd.schemaregistry.v1+json application/vnd.schemaregistry+json application/json

Not Implemented: The specified format parameter value is not supported
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string
Hide response attributes Show response attributes object
- error_code integer
- message string

POST /subjects/{subject}

curl \
 --request POST 'http://localhost:8081/subjects/{subject}' \
 --header "Content-Type: application/vnd.schemaregistry.v1+json"

curl \
 --request POST 'http://localhost:8081/subjects/{subject}' \
 --header "Content-Type: application/vnd.schemaregistry+json"

curl \
 --request POST 'http://localhost:8081/subjects/{subject}' \
 --header "Content-Type: application/json" \
 --data '{"schema":"string","schemaType":"string","references":[{"name":"string","subject":"string","version":42}],"metadata":{"properties":{"additionalProperty1":"string","additionalProperty2":"string"}}}'

Request examples

{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}

Request examples

{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}

Request examples

{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  }
}

Response examples (200)

{
  "subject": "string",
  "version": 42,
  "id": 42,
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "schema": "string"
}

Response examples (200)

{
  "subject": "string",
  "version": 42,
  "id": 42,
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "schema": "string"
}

Response examples (200)

{
  "subject": "string",
  "version": 42,
  "id": 42,
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "schema": "string"
}

Response examples (404)

{
  "error_code": 42,
  "message": "string"
}

Response examples (404)

{
  "error_code": 42,
  "message": "string"
}

Response examples (404)

{
  "error_code": 42,
  "message": "string"
}

Response examples (409)

{
  "error_code": 42,
  "message": "string"
}

Response examples (409)

{
  "error_code": 42,
  "message": "string"
}

Response examples (409)

{
  "error_code": 42,
  "message": "string"
}

Response examples (422)

{
  "error_code": 42,
  "message": "string"
}

Response examples (422)

{
  "error_code": 42,
  "message": "string"
}

Response examples (422)

{
  "error_code": 42,
  "message": "string"
}

Response examples (500)

{
  "error_code": 42,
  "message": "string"
}

Response examples (500)

{
  "error_code": 42,
  "message": "string"
}

Response examples (500)

{
  "error_code": 42,
  "message": "string"
}

Response examples (501)

{
  "error_code": 42,
  "message": "string"
}

Response examples (501)

{
  "error_code": 42,
  "message": "string"
}

Response examples (501)

{
  "error_code": 42,
  "message": "string"
}