Sign in
Consumer Shared Resources (cdx/v1)

Get shared resource's network configuration

General Availability

Returns network information of the shared resource

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

Path parameters

idstring required

The unique identifier for the consumer shared resource.

Response

The network information of the shared resource

api_version'cdx/v1'

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

kind'Network'

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

kafka_bootstrap_urlstring uri

The kafka cluster bootstrap url

zonesstring[]

The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink. Otherwise, they are automatically chosen by Confluent Cloud.

On AWS, zones are AWS AZ IDs (e.g. use1-az3)

On GCP, zones are GCP zones (e.g. us-central1-c).

On Azure, zones are Confluent-chosen names (e.g. 1, 2, 3) since Azure does not have universal zone identifiers.

dns_domainstring

The root DNS domain for the network if applicable.

zonal_subdomainsobject

The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and values are DNS domains.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/networks/n-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-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"
  },
  "kafka_bootstrap_url": "SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092",
  "zones": [
    "use1-az1",
    "use1-az2",
    "use1-az3"
  ],
  "dns_domain": "00000.us-east-1.aws.glb.confluent.cloud",
  "zonal_subdomains": {
    "use1-az1": "use1-az1.00000.us-east-1.aws.confluent.cloud",
    "use1-az4": "use1-az4.00000.us-east-1.aws.confluent.cloud",
    "use1-az5": "use1-az5.00000.us-east-1.aws.confluent.cloud"
  },
  "cloud": {
    "private_link_endpoint_service": "com.amazonaws.vpce.eu-west-3.vpce-00000000000000000"
  }
}

Changes

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