--- title: "List of Provider Shared Resources" method: GET path: "/cdx/v1/provider-shared-resources" tags: ["Provider Shared Resources (cdx/v1)"] --- # List of Provider Shared Resources `GET /cdx/v1/provider-shared-resources` [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all provider shared resources. ## Query parameters - `stream_share` string — Filter a collection by a string search - `crn` string — Filter a collection by a string search - `include_deleted` boolean — Filter for whether this value is true or false. - `page_size` integer - `page_token` string ## Response `200` Provider Shared Resource. - object — `ProviderSharedResource` object contains details of the data stream (topic, schema registry subjects, sharing metadata) that you have shared through Stream Sharing. ## The Provider Shared Resources Model - `api_version` 'cdx/v1', required — APIVersion defines the schema version of this representation of a resource. - `kind` 'ProviderSharedResourceList', required — Kind defines the object this REST resource represents. - `metadata` object, required — ListMeta describes metadata that resource collections may have - `first` string, uri, nullable — A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. - `last` string, uri, nullable — A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. - `prev` string, uri, nullable — A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. - `next` string, uri, nullable — A link to the next page of results. If a response does not contain a next link, then there is no more data available. - `total_size` integer — Number of records in the full result set. This response may be paginated and have a smaller number of records. - `data` object[], required — A data property that contains an array of resource items. Each entry in the array is a separate resource. - `api_version` 'cdx/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'ProviderSharedResource' — Kind defines the object this REST resource represents. - `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). - `metadata` object, required — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `crn` string, uri — Deprecated please use resources attribute. - `resources` string[] — List of resource crns that are shared together - `display_name` string, required — Shared resource display name - `description` string — Description of shared resource - `tags` string[] — list of tags - `schemas` object[] — List of schemas in JSON format. This field is work in progress and subject to changes. - `subject` string — Name of the subject - `version` integer — Version number - `id` integer — Globally unique identifier of the schema - `schema_type` string — Schema type - `schema` string — Schema definition string - `organization_description` string — Shared resource's organization description - `organization_contact` string, email — Email of contact person from the organization - `logo_url` string, uri — Resource logo url - `organization_name` string, required — Organization to which the shared resource belongs. Deprecated - `environment_name` string, required — The environment name of the shared resource. Deprecated - `cluster_name` string, required — The cluster display name of the shared resource. Deprecated - `cloud_cluster` object, required — The cloud cluster to which this belongs. - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource ## Other responses - `400` — Bad Request - `401` — The request lacks valid authentication credentials for this resource. - `403` — The access credentials were considered insufficient to grant access - `429` — Rate Limit Exceeded - `500` — Oops, something went wrong! --- [API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)