---
title: "Read a Network"
method: GET
path: "/networking/v1/networks/{id}"
tags: ["Networks (networking/v1)"]
---

# Read a Network

`GET /networking/v1/networks/{id}`

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

Make a request to read a network.

## Path parameters

- `id` string, required

## Query parameters

- `environment` string, required — Filter a collection by a string search

## Response `200`

Network.

- object — `Network` represents a network (VPC) in Confluent Cloud. All Networks exist within Confluent-managed cloud provider accounts. Dedicated networks support more networking options but can only contain Dedicated clusters. Shared networks can contain any cluster type. The API allows you to list, create, read, update, and delete your networks. Related guide: [APIs to manage networks in Confluent Cloud](https://docs.confluent.io/cloud/current/networking/overview.html). ## The Networks Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.Network" /> ## Quotas and Limits This resource is subject to the [following quotas](https://docs.confluent.io/cloud/current/quotas/overview.html): | Quota | Description | | --- | --- | | `dedicated_networks_per_environment` | Number of dedicated networks per Confluent Cloud environment |
  - `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'Network', required — Kind defines the object this REST resource represents.
  - `id` string, 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").
  - `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.
  - `spec` object, required — The desired state of the Network
    - `display_name` string — The name of the network
    - `cloud` string, required — The cloud service provider in which the network exists.
    - `region` string, required — The cloud service provider region in which the network exists.
    - `connection_types` NetworkingV1ConnectionType[], required — The connection types requested for use with the network.
    - `cidr` string — The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. Must be `/16`. Required for VPC peering and AWS TransitGateway.
    - `zones` string[] — The 3 availability zones for this network. They can optionally be specified for AWS networks used with PrivateLink, for GCP networks used with Private Service Connect, and for AWS and GCP networks used with Peering. 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.
    - `zones_info` NetworkingV1ZoneInfo[] — Each item represents information related to a single zone. Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
      - `zone_id` string — Cloud provider zone id
      - `cidr` string — The IPv4 [CIDR block](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) to used for this network. Must be a `/27`. Required for VPC peering and AWS TransitGateway.
    - `dns_config` NetworkingV1DnsConfig — The network DNS config
      - `resolution` string, required — Network DNS resolution type.
    - `reserved_cidr` string — The reserved CIDR config is used only by AWS networks with connection_types = Vpc_Peering or Transit_Gateway An IPv4 [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) reserved for Confluent Cloud Network. Must be \24. If not specified, Confluent Cloud Network uses 172.20.255.0/24 Note - The attribute is in a [Limited Availability lifecycle stage](https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `gateway` TypedEnvScopedObjectReference — ObjectReference provides information for you to locate the referred object
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
  - `status` NetworkingV1NetworkStatus, required — The status of the Network
    - `phase` string, required — The lifecyle phase of the network: PROVISIONING: network provisioning is in progress; READY: network is ready; FAILED: provisioning failed; DEPROVISIONING: network deprovisioning is in progress;
    - `supported_connection_types` NetworkingV1ConnectionType[], required — The connection types this network supports.
    - `active_connection_types` NetworkingV1ConnectionType[], required — The connection types requested for use with the network.
    - `error_code` string — Error code if network is in a failed state. May be used for programmatic error checking.
    - `error_message` string — Displayable error message if network is in a failed state
    - `dns_domain` string — The root DNS domain for the network if applicable. Present on networks that support PrivateLink.
    - `endpoint_suffix` string — The endpoint suffix for the network, if applicable. Full service endpoints can be constructed by appending the service identifier to the beginning of the endpoint suffix. For example, the Flink REST endpoint can be constructed by adding "flink" - 'https://flink' + 'endpoint_suffix'.
    - `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.
      - object — The AWS network details.
        - `kind` 'AwsNetwork', required — Network kind type.
        - `vpc` string, required — The Confluent Cloud VPC ID.
        - `account` string, required — The AWS account ID associated with the Confluent Cloud VPC.
        - `private_link_endpoint_service` string — The endpoint service of the Confluent Cloud VPC. (used for PrivateLink) if available.
      - object — The GCP network details.
        - `kind` 'GcpNetwork', required — Network kind type.
        - `project` string, required — The GCP Project ID associated with the Confluent Cloud VPC.
        - `vpc_network` string, required — The network name of the Confluent Cloud VPC.
        - `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)
      - object — The Azure network details.
        - `kind` 'AzureNetwork', required — Network kind type.
        - `vnet` string, required — The resource ID of the Confluent Cloud VNet.
        - `subscription` string, required — The Azure Subscription ID associated with the Confluent Cloud VPC.
        - `private_link_service_aliases` object — The mapping of zones to Private Link Service Aliases if available. Keys are zones and values are [Azure Private Link Service Aliases](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
        - `private_link_service_resource_ids` object — The mapping of zones to Private Link Service Resource IDs if available. Keys are zones and values are [Azure Private Link Service Resource IDs](https://docs.microsoft.com/en-us/azure/private-link/private-link-service-overview#share-your-service).
    - `idle_since` string, date-time — The date and time when the network becomes idle

## 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)