Sign in
Consumer Shared Resources (cdx/v1)

List of Consumer Shared Resources

General Availability

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

get/cdx/v1/consumer-shared-resources

Query parameters

stream_sharestring

Filter a collection by a string search

Filter the results by exact match for stream_share.

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

Consumer Shared Resource.

api_version'cdx/v1' required

APIVersion defines the schema version of this representation of a resource.

kind'ConsumerSharedResourceList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources",
    "last": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources/csr-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-shared-resource=csr-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"
      },
      "cloud": "AWS",
      "network_connection_types": [
        "PRIVATELINK"
      ],
      "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_name": "ABC Corp",
      "organization_description": "ABC Corp is the biggest online retailer",
      "organization_contact": "jane.doe@example.com",
      "logo_url": "https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo"
    }
  ]
}

Changes

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