---
title: "Update Network"
method: PATCH
path: "/v2/cloud-gateways/networks/{networkId}"
tags: ["Networks"]
---

# Update Network

`PATCH /v2/cloud-gateways/networks/{networkId}`

Updates a Cloud Gateway network by ID. You can also rename the network.

## Path parameters

- `networkId` string, uuid, required — The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

## Request body

- PatchNetworkRequest — Request schema for updating a network.
  - `name` string — Human-readable name of the network.

## Response `200`

Response format for patching a network.

- Network — Object containing information about a network to be used in configurations.
  - `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
- `404` — Not Found
- `409` — Conflict

## Changes

> 75 revisions in range; 10 could not be searched.

- **2026-08-07** `0261aef4b1e2` — 1 breaking
  - the `state` response's property type/format changed from ``/`` to `string`/`` for status `200`
- **2025-10-23** `8ab3ec3ed301` — 1 warning
  - added the new `type` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2025-08-22** `3c0154b2053a` — 13 breaking
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterChoiceItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterDependentItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMaximumLength]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/source` became nullable for the status `400`
  - …9 more
- **2025-05-14** `87c135153b84` — 1 info
  - added the optional property `state_metadata` to the response with the `200` status

[Change history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v2/cloud-gateways/networks/:networkId/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/7d3c634668f8/schema)