Stay organized with collections
Save and categorize content based on your preferences.
This document shows you how to view the details of a schema registry resource
within Managed Service for Apache Kafka. You can view details such as its configuration,
associated contexts, and subjects.
You can't use the open source Apache Kafka client APIs to view these specific
Managed Service for Apache Kafka schema registry resource details.
This predefined role contains
the permissions required to view a schema registry. To see the exact permissions that are
required, expand the Required permissions section:
Required permissions
The following permissions are required to view a schema registry:
Grant this permission on the schema registry resource:
managedkafka.schemaRegistries.get
To retrieve the details of a specific schema registry instance using the
REST API, make a GET request to the following URI:
GET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID
Authorization: Bearer $(gcloud auth application-default print-access-token)
Replace the following:
PROJECT_ID (required): your Google Cloud project ID.
LOCATION (required): the region where the schema registry exists.
SCHEMA_REGISTRY_ID (required): the unique ID of the schema registry that
you want to view.
If the request is successful, the API returns a 200 OK status
code. The response body contains a JSON object representing the details of
the requested schema registry.
For example, the following is a response to a command to get the details of a schema
registry called gcloud_test located in the region us-central1:
When you view a schema registry in the Google Cloud console, the
Schema registry details page displays the following information for the
selected registry:
Region: the Google Cloud region where the registry
resides.
Schema registry URL: the endpoint URL for the schema
registry. This is of the format
https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID.
For example—https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry
Schema mode: the operational mode that you can set at the
schema registry level and the individual subject level. This setting controls
whether modifications can be made.
Compatibility type: the registry-level configuration for
the default compatibility setting enforced for new subjects or schema versions
within this registry (unless overridden at the subject or context level).
Common values include BACKWARD, FORWARD,
FULL, or NONE.
Subjects in this schema registry: a list of subject
names associated with the registry. If a context is available, you can
also view the context for each subject.
Apache Kafka® is a registered
trademark of The Apache Software Foundation or its affiliates in the United
States and/or other countries.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# View schema registry details\n\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nThis document shows you how to view the details of a schema registry resource\nwithin Managed Service for Apache Kafka. You can view details such as its configuration,\nassociated contexts, and subjects.\n\nYou can't use the open source Apache Kafka client APIs to view these specific\nManaged Service for Apache Kafka schema registry resource details.\n\nRequired roles and permissions\n------------------------------\n\n\nTo get the permissions that\nyou need to view a schema registry,\n\nask your administrator to grant you the\n\n\n[Managed Kafka Schema Registry Viewer](/iam/docs/roles-permissions/managedkafka#managedkafka.schemaRegistryViewer) (`roles/managedkafka.schemaRegistryViewer`)\nIAM role on the schema registry instance.\n\n\nFor more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\nThis predefined role contains\n\nthe permissions required to view a schema registry. To see the exact permissions that are\nrequired, expand the **Required permissions** section:\n\n\n#### Required permissions\n\nThe following permissions are required to view a schema registry:\n\n- Grant this permission on the schema registry resource: ` ``managedkafka.schemaRegistries.get`\n\n\nYou might also be able to get\nthese permissions\nwith [custom roles](/iam/docs/creating-custom-roles) or\nother [predefined roles](/iam/docs/roles-overview#predefined).\n\nFor more information about the predefined roles available for\nManaged Service for Apache Kafka, see the\n[Access control documentation](/managed-service-for-apache-kafka/docs/access-control#predefined-roles).\n\nView schema registry details\n----------------------------\n\nTo retrieve the configuration and details of a specific schema registry, follow\nthese steps: \n\n### Console\n\n1. In the Google Cloud console, go to the **Schema registries** page.\n\n [Go to schema registries](https://console.cloud.google.com/managedkafka/schemaRegistries)\n\n A list of schema registries in your project is displayed.\n2. Click the name of the schema registry whose details you want to view. The **Schema registry details** page opens. The information displayed on\n this page is explained in the [Schema registry page details](#schema-registry-page-details) section.\n\n### gcloud\n\n1.\n [Install](/sdk/docs/install) the Google Cloud CLI.\n\n After installation,\n [initialize](/sdk/docs/initializing) the Google Cloud CLI by running the following command:\n\n ```bash\n gcloud init\n ```\n\n\n If you're using an external identity provider (IdP), you must first\n [sign in to the gcloud CLI with your federated identity](/iam/docs/workforce-log-in-gcloud).\n2. To retrieve the configuration and details of a specific schema registry, run the [`gcloud beta managed-kafka schema-registries describe`](/sdk/gcloud/reference/beta/managed-kafka/schema-registries/describe) command: \n\n```bash\ngcloud beta managed-kafka schema-registries describe SCHEMA_REGISTRY_ID \\\n --location=LOCATION \\\n```\n3. Replace the following:\n - \u003cvar translate=\"no\"\u003eSCHEMA_REGISTRY_ID\u003c/var\u003e (required): the ID of the schema registry you want to describe.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e (required): the Google Cloud region where the schema registry is located.\n\nFor example, the following command gets the details of a schema\nregistry called `test_SR` located in the\nregion `us-central1`: \n\n```bash\ngcloud beta managed-kafka schema-registries describe test_SR \\\n --location=us-central1\n```\n\nThe command returns the output similar to the following: \n\n```bash\nDescribing schema registry: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR\nname: projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR\nmode: READWRITE\nconfig:\n - compatibility: BACKWARD\ncontexts:\n - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/.\n - projects/test-pubsub/locations/us-central1/schemaRegistries/test_SR/contexts/user-record\n```\n\n### REST\n\n- To retrieve the details of a specific schema registry instance using the REST API, make a `GET` request to the following URI: \n\n```\nGET https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries/SCHEMA_REGISTRY_ID\nAuthorization: Bearer $(gcloud auth application-default print-access-token)\n```\n- Replace the following:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e (required): your Google Cloud project ID.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e (required): the region where the schema registry exists.\n - \u003cvar translate=\"no\"\u003eSCHEMA_REGISTRY_ID\u003c/var\u003e (required): the unique ID of the schema registry that you want to view.\n\nIf the request is successful, the API returns a `200 OK` status\ncode. The response body contains a JSON object representing the details of\nthe requested schema registry.\n\nFor example, the following is a response to a command to get the details of a schema\nregistry called `gcloud_test` located in the region `us-central1`: \n\n```json\n{\n \"name\": \"projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test\",\n \"contexts\": [\n \"projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/default\",\n \"projects/testing-311516/locations/us-central1/schemaRegistries/gcloud_test/contexts/.\"\n ]\n}\n```\n\nFor more information, see the\n[REST API documentation](/managed-service-for-apache-kafka/docs/reference/rest).\n\n\u003cbr /\u003e\n\nSchema registry page details\n----------------------------\n\nWhen you view a schema registry in the Google Cloud console, the\n**Schema registry details** page displays the following information for the\nselected registry:\n\n- **Region**: the Google Cloud region where the registry resides.\n- **Schema registry URL** : the endpoint URL for the schema registry. This is of the format `https://managedkafka.googleapis.com/v1main/projects/`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`/locations/`\u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e`/schemaRegistries/`\u003cvar translate=\"no\"\u003eSCHEMA_REGISTRY_ID\u003c/var\u003e.\n\n For example---`https://managedkafka.googleapis.com/v1main/projects/managed-kafka-project/locations/us-central1/schemaRegistries/testschemaregistry`\n- **Schema mode**: the operational mode that you can set at the schema registry level and the individual subject level. This setting controls whether modifications can be made.\n- **Compatibility type** : the registry-level configuration for the default compatibility setting enforced for new subjects or schema versions within this registry (unless overridden at the subject or context level). Common values include `BACKWARD`, `FORWARD`, `FULL`, or `NONE`.\n- **Subjects in this schema registry**: a list of subject names associated with the registry. If a context is available, you can also view the context for each subject.\n\n*Apache Kafka® is a registered\ntrademark of The Apache Software Foundation or its affiliates in the United\nStates and/or other countries.*"]]