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

# Update Network

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

Updates a network by ID.

## Path parameters

- `networkId` string, uuid, required

## 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
  - `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 configuration for the network.
  - `state` 'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated', required — State of the network.
  - `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

- **2025-05-21** `69704304ad5f` — 1 info
  - added the optional property `state_metadata` to the response with the `200` status
- **2025-02-10** `d833d4dbb1fa` — 1 warning
  - added the new `missing_reference` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2024-11-11** `08ead66e9ebb` — 1 breaking, 5 warning, 1 info
  - added `#/components/schemas/InvalidParameterMaximumLength` to the `allOf[subschema #2]/invalid_parameters/items/` response property `oneOf` list for the response status `400`
  - removed the request property `firewall`
  - removed the optional property `ddos_protection` from the response with the `200` status
  - removed the optional property `firewall` from the response with the `200` status
  - …3 more

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

---

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