Get a schema by GUID.

GET /schemas/guids/{guid}

Redpanda version 26.3 or later. Get the schema whose content has the GUID. A globally unique identifier (GUID) identifies the content of a schema across all contexts. Redpanda considers only the schema IDs that a subject version uses, including soft-deleted versions. If several schema IDs have the GUID, Redpanda uses the highest one in the default context that you have permission to read. If the default context has no such ID, Redpanda uses the first context in order of context name.

Path parameters

  • guid string Required

    The GUID of the schema.

Query parameters

  • format string

    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.

Responses

  • OK

    Hide response attributes Show response attributes object
    • 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
      Hide metadata attribute Show metadata attribute object
      • properties object
        Hide properties attribute Show properties attribute object
        • * string Additional properties
    • guid string

      Redpanda version 26.3 or later. The GUID of the schema.

    Hide response attributes Show response attributes object
    • 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
      Hide metadata attribute Show metadata attribute object
      • properties object
        Hide properties attribute Show properties attribute object
        • * string Additional properties
    • guid string

      Redpanda version 26.3 or later. The GUID of the schema.

    Hide response attributes Show response attributes object
    • 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
      Hide metadata attribute Show metadata attribute object
      • properties object
        Hide properties attribute Show properties attribute object
        • * string Additional properties
    • guid string

      Redpanda version 26.3 or later. The GUID of the schema.

  • Forbidden: Authorization is enabled, and you cannot read any schema ID that has the GUID

    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
  • Not Found: The GUID is not valid, or no subject version uses a schema ID that has the GUID

    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
  • 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
  • Not Implemented: The 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
GET /schemas/guids/{guid}
curl \
 --request GET 'http://localhost:8081/schemas/guids/{guid}'
Response examples (200)
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "guid": "string"
}
Response examples (200)
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "guid": "string"
}
Response examples (200)
{
  "schema": "string",
  "schemaType": "string",
  "references": [
    {
      "name": "string",
      "subject": "string",
      "version": 42
    }
  ],
  "metadata": {
    "properties": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    }
  },
  "guid": "string"
}
Response examples (403)
{
  "error_code": 42,
  "message": "string"
}
Response examples (403)
{
  "error_code": 42,
  "message": "string"
}
Response examples (403)
{
  "error_code": 42,
  "message": "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 (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"
}