Sign in
Provider Shared Resources (cdx/v1)

Update a Provider Shared Resource

General Availability

Make a request to update a provider shared resource.

patch/cdx/v1/provider-shared-resources/{id}

Path parameters

idstring required

The unique identifier for the provider shared resource.

Request body

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.

idstring

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

crnstring uri

Deprecated please use resources attribute.

resourcesstring[]

List of resource crns that are shared together

display_namestring

Shared resource display name

descriptionstring

Description of shared resource

tagsstring[]

list of tags

organization_descriptionstring

Shared resource's organization description

organization_contactstring email

Email of contact person from the organization

logo_urlstring uri

Resource logo url

organization_namestring

Organization to which the shared resource belongs. Deprecated

environment_namestring

The environment name of the shared resource. Deprecated

cluster_namestring

The cluster display name of the shared resource. Deprecated

Example request

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

Response

Provider Shared Resource.

api_version'cdx/v1' required

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

kind'ProviderSharedResource' 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").

crnstring uri

Deprecated please use resources attribute.

resourcesstring[]

List of resource crns that are shared together

display_namestring required

Shared resource display name

descriptionstring

Description of shared resource

tagsstring[]

list of tags

organization_descriptionstring

Shared resource's organization description

organization_contactstring email

Email of contact person from the organization

logo_urlstring uri

Resource logo url

organization_namestring required

Organization to which the shared resource belongs. Deprecated

environment_namestring required

The environment name of the shared resource. Deprecated

cluster_namestring required

The cluster display name of the shared resource. Deprecated

Example response

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