---
title: "Get shared resource's network configuration"
method: GET
path: "/cdx/v1/consumer-shared-resources/{id}:network"
tags: ["Consumer Shared Resources (cdx/v1)"]
---

# Get shared resource's network configuration

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

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Returns network information of the shared resource

## Path parameters

- `id` string, required

## Response `200`

The network information of the shared resource

- CdxV1Network — The shared cluster's network configurations for consumer to setup private link
  - `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.
  - `id` string — 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").
  - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
    - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
    - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
    - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
    - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
  - `kafka_bootstrap_url` string, uri — The kafka cluster bootstrap url
  - `zones` string[] — 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](https://docs.aws.amazon.com/ram/latest/userguide/working-with-az-ids.html) (e.g. use1-az3) On GCP, zones are GCP [zones](https://cloud.google.com/compute/docs/regions-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_domain` string — The root DNS domain for the network if applicable.
  - `zonal_subdomains` object — The DNS subdomain for each zone. Present on networks that support PrivateLink. Keys are zones and values are DNS domains.
  - `cloud` union — The cloud-specific network details. These will be populated when the network reaches the READY state.
    - CdxV1AwsNetwork — The AWS network details.
      - `kind` 'AwsNetwork', required — Network kind type.
      - `private_link_endpoint_service` string — The AWS VPC endpoint service for the network (used for PrivateLink) if available.
    - CdxV1AzureNetwork — The Azure network details.
      - `kind` 'AzureNetwork', required — Network kind type.
      - `private_link_service_aliases` object — The mapping of zones to PrivateLink Service Aliases if available. Keys are zones and values are [Azure PrivateLink Service Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service)
    - CdxV1GcpNetwork — The GCP network details.
      - `kind` 'GcpNetwork', required — Network kind type.
      - `private_service_connect_service_attachments` object — The mapping of zones to Private Service Connect Service Attachments if available. Keys are zones and values are [GCP Private Service Connect Service Attachment](https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#api_7)

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)