---
title: "List Networks"
method: GET
path: "/v2/cloud-gateways/networks"
tags: ["Networks"]
---

# List Networks

`GET /v2/cloud-gateways/networks`

Returns a paginated list of Cloud Gateway networks visible to the caller. Filter by
`state` to narrow results — for example, poll for `state=ready` to find networks
available for data plane group configurations.

## Query parameters

- `filter` NetworksFilterParameters
  - `name` CloudGatewaysStringFieldFilterOverride — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `neq` string — The field does not match the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `ocontains` string — The field contains any of the provided values.
  - `state` NetworkStateFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` 'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated' — The current state of the network. Possible values: - `created`: The network was created, but provisioning hasn't started yet. - `initializing`: The network is being provisioned in the cloud provider. - `offline`: The network was created but isn't provisioned; no data planes can be deployed. - `ready`: The network is fully provisioned and available for data plane groups. - `terminating`: The network is being deleted and is no longer accepting new resources. - `terminated`: The network has been fully deleted and is no longer available.
    - `neq` 'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated' — The current state of the network. Possible values: - `created`: The network was created, but provisioning hasn't started yet. - `initializing`: The network is being provisioned in the cloud provider. - `offline`: The network was created but isn't provisioned; no data planes can be deployed. - `ready`: The network is fully provisioned and available for data plane groups. - `terminating`: The network is being deleted and is no longer accepting new resources. - `terminated`: The network has been fully deleted and is no longer available.
    - `oeq` string — The field matches any of the provided values.
- `page[size]` integer
- `page[number]` integer

## Response `200`

A paginated list for a collection of networks.

- object
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` Network[], required
    - `id` string, uuid, required — The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
    - `name` string, required — Human-readable name of the network.
    - `default` boolean, required — Whether the network is a default network or not. Default networks are Networks that are created automatically by Konnect when an organization is linked to a provider account.
    - `cloud_gateway_provider_account_id` string, uuid, required
    - `region` string, required — Region ID for cloud provider region.
    - `availability_zones` string[], required — List of availability zones that the network is attached to.
    - `cidr_block` string, required — CIDR block for the network. Must not overlap with reserved blocks for the target region. Query the Resource Availability endpoint for valid CIDR ranges per region and provider.
    - `state` 'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated', required — The current state of the network. Possible values: - `created`: The network was created, but provisioning hasn't started yet. - `initializing`: The network is being provisioned in the cloud provider. - `offline`: The network was created but isn't provisioned; no data planes can be deployed. - `ready`: The network is fully provisioned and available for data plane groups. - `terminating`: The network is being deleted and is no longer accepting new resources. - `terminated`: The network has been fully deleted and is no longer available.
    - `state_metadata` NetworkStateMetadata — Metadata describing the backing state of the network and why it may be in an erroneous state.
      - `reported_status` string — Reported status of the network from backing infrastructure.
      - `reason` string — Reason why the network may be in an erroneous state, reported from backing infrastructure.
    - `provider_metadata` NetworkProviderMetadata, required — Metadata describing attributes returned by cloud-provider for the network.
      - `vpc_id` string
      - `subnet_ids` string[]
    - `transit_gateway_count` integer, required — The number of transit gateways attached to this network.
    - `configuration_reference_count` integer, required — The number of configurations that reference this network.
    - `entity_version` integer, required — Monotonically-increasing version count of the network, to indicate the order of updates to the network.
    - `created_at` string, date-time, required — An RFC-3339 timestamp representation of network creation date.
    - `updated_at` string, date-time, required — An RFC-3339 timestamp representation of network update date.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kong/apis/konnect-api.md) · [All operations](https://skmtc.net/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api/versions/06734a9c491f/schema)