Sign in
Consumer Shared Resources (cdx/v1)

Read a Consumer Shared Resource

General Availability

Make a request to read a consumer shared resource.

get/cdx/v1/consumer-shared-resources/{id}

Path parameters

idstring required

The unique identifier for the consumer shared resource.

Response

Consumer Shared Resource.

api_version'cdx/v1' required

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

kind'ConsumerSharedResource' required

Kind defines the object this REST resource represents.

idstring 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").

cloudstring required

The cloud service provider of the provider shared cluster.

network_connection_typesCdxV1ConnectionType[]

The network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty

display_namestring required

Consumer resource display name

descriptionstring

Description of consumer resource

tagsstring[]

list of tags

organization_namestring required

Shared resource's organization name

organization_descriptionstring

Shared resource's organization description

organization_contactstring email

Email of the shared resource's organization contact

logo_urlstring uri

Resource logo url

Example response

{
  "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.