Sign in
Networks (networking/v1)

List of Networks

General Availability

Retrieve a sorted, filtered, paginated list of all networks.

get/networking/v1/networks

Query parameters

spec.display_namestring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values.

spec.cloudstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.cloud. Pass multiple times to see results matching any of the values.

spec.regionstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.region. Pass multiple times to see results matching any of the values.

spec.connection_typesstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.connection_types. Pass multiple times to see results matching any of the values.

spec.cidrstring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for spec.cidr. Pass multiple times to see results matching any of the values.

status.phasestring[]

Filter a collection by a string search for one or more values

Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values.

environmentstring required

Filter a collection by a string search

Filter the results by exact match for environment.

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Network.

api_version'networking/v1' required

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

kind'NetworkList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/networking/v1/networks",
    "last": "https://api.confluent.cloud/networking/v1/networks?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/networking/v1/networks?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/networking/v1/networks?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/networking/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"
      },
      "spec": {
        "display_name": "prod-aws-us-east1",
        "cloud": "AWS",
        "region": "us-east-1",
        "connection_types": [
          "PRIVATELINK"
        ],
        "cidr": "10.200.0.0/16",
        "zones": [
          "use1-az1",
          "use1-az2",
          "use1-az3"
        ],
        "zones_info": [
          {
            "zone_id": "use1-az3",
            "cidr": "10.20.0.0/27"
          }
        ],
        "reserved_cidr": "172.20.255.0/24",
        "environment": {
          "id": "env-00000",
          "related": "https://api.confluent.cloud/v2/environments/env-00000",
          "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
        }
      },
      "status": {
        "phase": "READY",
        "supported_connection_types": [
          "PRIVATELINK"
        ],
        "active_connection_types": [
          "PRIVATELINK"
        ],
        "error_code": "insufficient_capacity",
        "error_message": "Could not provision cloud resources",
        "dns_domain": "00000.us-east-1.aws.glb.confluent.cloud",
        "endpoint_suffix": ".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": {
          "vpc": "vpc-00000000000000000",
          "account": "000000000000",
          "private_link_endpoint_service": "com.amazonaws.vpce.eu-west-3.vpce-00000000000000000"
        },
        "idle_since": "2024-01-01T00:00:00Z"
      }
    }
  ]
}

Changes

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