---
title: "Update network"
method: POST
path: "/api/v2/network/{id}"
tags: ["network"]
---

# Update network

`POST /api/v2/network/{id}`

## Request

- Base URL: `https://central.zerotier.com`
- URL: `https://central.zerotier.com/api/v2/network/{id}`
- Auth: HTTP bearer

Update the name, description, or configuration of a network. Only provided fields are updated.

## Path parameters

- `id` string, required

## Request body

- UpdateNetworkRequest: All fields are optional. Only provided fields are updated.
  - `name` string: Display name for the network
  - `description` string: Description of the network (may be an empty string)
  - `config` NetworkConfigRequest: Network configuration. All fields are optional when updating.
    - `dns` DNS
      - `domain` string, required: Search domain to use for DNS records
      - `servers` string[], required: IP addresses of unicast DNS servers (IPv4 or IPv6)
    - `enableBroadcast` boolean: Enable broadcast packets on the network
    - `v4Subnet` string: CIDR subnet that defines the IPv4 network boundary
    - `v6Subnet` string: CIDR subnet that defines the IPv6 network boundary
    - `v4IpAssignmentPools` IPRange[]: IP address ranges for the IPv4 auto-assignment pool
      - `ipRangeStart` string, required: Start of the IP address range (inclusive)
      - `ipRangeEnd` string, required: End of the IP address range (inclusive)
    - `v6IpAssignmentPools` IPRange[]: IP address ranges for the IPv6 auto-assignment pool
      - `ipRangeStart` string, required: Start of the IP address range (inclusive)
      - `ipRangeEnd` string, required: End of the IP address range (inclusive)
    - `mtu` integer: MTU to set on the client virtual network adapter
    - `multicastLimit` integer: Maximum number of recipients per multicast or broadcast. Warning — setting this to 0 will disable IPv4 communication on your network!
    - `private` boolean: Whether the network is private. If `false`, devices will **not** need to be authorized to join.
    - `routes` Route[]: Static routes to push to network members
      - `target` string, required: Destination CIDR for this route
      - `via` string, required: Next-hop IP address, or null to route directly on the ZeroTier network
    - `v4AssignmentMode` IPV4AssignMode
      - `zt` boolean, required: Enable ZeroTier auto-assignment of IPv4 addresses from the assignment pool
    - `v6AssignmentMode` IPV6AssignMode
      - `6plane` boolean, required: Enable 6PLANE addressing (a /80 per device from a /40 assigned to the network)
      - `rfc4193` boolean, required: Enable RFC 4193 private addressing (a /128 per device from a /88 assigned to the network)
      - `zt` boolean, required: Enable ZeroTier auto-assignment of IPv6 addresses from the assignment pool

## Response `200`

Updated network details

- NetworkResponse
  - `id` string, required: Unique network identifier
  - `name` string, required: Display name of the network
  - `networkGroupId` string, required: ID of the network group this network belongs to
  - `description` string: Description of the network (may be an empty string)
  - `config` NetworkConfigResponse, required
    - `dns` DNS, required
      - `domain` string, required: Search domain to use for DNS records
      - `servers` string[], required: IP addresses of unicast DNS servers (IPv4 or IPv6)
    - `enableBroadcast` boolean, required: Enable broadcast packets on the network
    - `v4Subnet` string, required: CIDR subnet that defines the IPv4 network boundary
    - `v6Subnet` string, required: CIDR subnet that defines the IPv6 network boundary
    - `v4IpAssignmentPools` IPRange[], required: IP address ranges for the IPv4 auto-assignment pool
      - `ipRangeStart` string, required: Start of the IP address range (inclusive)
      - `ipRangeEnd` string, required: End of the IP address range (inclusive)
    - `v6IpAssignmentPools` IPRange[], required: IP address ranges for the IPv6 auto-assignment pool
      - `ipRangeStart` string, required: Start of the IP address range (inclusive)
      - `ipRangeEnd` string, required: End of the IP address range (inclusive)
    - `mtu` integer, required: MTU to set on the client virtual network adapter
    - `multicastLimit` integer, required: Maximum number of recipients per multicast or broadcast. Warning — setting this to 0 will disable IPv4 communication on your network!
    - `private` boolean, required: Whether the network is private. If `false`, devices will **not** need to be authorized to join.
    - `routes` Route[], required: Static routes pushed to network members
      - `target` string, required: Destination CIDR for this route
      - `via` string, required: Next-hop IP address, or null to route directly on the ZeroTier network
    - `v4AssignmentMode` IPV4AssignMode, required
      - `zt` boolean, required: Enable ZeroTier auto-assignment of IPv4 addresses from the assignment pool
    - `v6AssignmentMode` IPV6AssignMode, required
      - `6plane` boolean, required: Enable 6PLANE addressing (a /80 per device from a /40 assigned to the network)
      - `rfc4193` boolean, required: Enable RFC 4193 private addressing (a /128 per device from a /88 assigned to the network)
      - `zt` boolean, required: Enable ZeroTier auto-assignment of IPv6 addresses from the assignment pool
  - `creationTime` string, date-time, required: Time the network was created
  - `lastModified` string, date-time, required: Time the network was last modified
  - `kind` string, required: The kind of ZeroTier network (e.g. `v1`)

## Other responses

- `400`: Invalid data provided
- `401`: Missing or invalid authentication token
- `403`: Insufficient permissions
- `404`: Network not found
- `413`: Request body exceeds the 1 MB size limit
- `500`: Internal server error

---

[API](https://skmtc.dev/zerotier/apis/zerotier-central-v2-api.md) - [All operations](https://skmtc.dev/zerotier/apis/zerotier-central-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zerotier/apis/zerotier-central-v2-api/revisions/b2e7468ad104?raw)