Sign in
Provider Shared Resources (cdx/v1)

List of Provider Shared Resources

General Availability

Retrieve a sorted, filtered, paginated list of all provider shared resources.

get/cdx/v1/provider-shared-resources

Query parameters

stream_sharestring

Filter a collection by a string search

Filter the results by exact match for stream_share.

crnstring

Filter a collection by a string search

Filter the results by exact match for crn.

include_deletedboolean

Filter for whether this value is true or false.

Include deactivated shared resources

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Provider Shared Resource.

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.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/cdx/v1/provider-shared-resources",
    "last": "https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/cdx/v1/provider-shared-resources?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/cdx/v1/provider-shared-resources/psr-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/provider-shared-resource=psr-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "crn": "crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic",
      "resources": [
        "crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic"
      ],
      "display_name": "Stock Trades",
      "description": "This topic provides realtime data for the orders placed through the website",
      "tags": [
        "recent",
        "pending"
      ],
      "schemas": [
        {
          "subject": "User",
          "version": 1,
          "id": 100001,
          "schema_type": "AVRO",
          "schema": "{\"schema\": \"{\"type\": \"string\"}\"}"
        }
      ],
      "organization_description": "ABC Corp is the biggest online retailer",
      "organization_contact": "jane.doe@example.com",
      "logo_url": "https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo",
      "organization_name": "ABC Corp",
      "environment_name": "Public Env",
      "cluster_name": "Published Trades",
      "cloud_cluster": {
        "id": "lkc-00000",
        "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.