Sign in
Networks

Update Network

Updates a network by ID.

patch/v2/cloud-gateways/networks/{networkId}

Path parameters

networkIdstring uuid required
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request body

namestring

Human-readable name of the network.

Example request

{
  "name": "us-east-2 network"
}

Response

Response format for patching a network.

idstring uuid required
namestring required

Human-readable name of the network.

defaultboolean 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_idstring uuid required
regionstring required

Region ID for cloud provider region.

availability_zonesstring[] required

List of availability zones that the network is attached to.

cidr_blockstring required

CIDR block configuration for the network.

state'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated' required

State of the network.

transit_gateway_countinteger required

The number of transit gateways attached to this network.

configuration_reference_countinteger required

The number of configurations that reference this network.

entity_versioninteger required

Monotonically-increasing version count of the network, to indicate the order of updates to the network.

created_atstring date-time required

An RFC-3339 timestamp representation of network creation date.

updated_atstring date-time required

An RFC-3339 timestamp representation of network update date.

Example response

{
  "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  "name": "us-east-2 network",
  "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  "region": "us-east-2",
  "availability_zones": [
    "use2-az1",
    "use2-az2",
    "use2-az3"
  ],
  "cidr_block": "10.0.0.0/8",
  "state_metadata": {
    "reported_status": "INVALID",
    "reason": "Network could not be deployed due to insufficient cloud provider compute instances.\n"
  },
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes