network

Update network

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

post/api/v2/network/{id}

Request

  • Base URL
    https://central.zerotier.com
  • Auth
    HTTP bearer

Path parameters

idstring required

The network ID

Request body

namestring

Display name for the network

descriptionstring

Description of the network (may be an empty string)

Example request

{
  "name": "office-network-v2",
  "config": {
    "mtu": 2800,
    "private": true
  }
}

Response

Updated network details

idstring required

Unique network identifier

namestring required

Display name of the network

networkGroupIdstring required

ID of the network group this network belongs to

descriptionstring

Description of the network (may be an empty string)

creationTimestring date-time required

Time the network was created

lastModifiedstring date-time required

Time the network was last modified

kindstring required

The kind of ZeroTier network (e.g. v1)

Example response

{
  "config": {
    "dns": {
      "domain": "some.domain",
      "servers": [
        "10.0.0.3"
      ]
    },
    "enableBroadcast": true,
    "v4Subnet": "192.168.0.0/16",
    "v6Subnet": "2001:db8::/32",
    "v4IpAssignmentPools": [
      {
        "ipRangeStart": "10.0.0.1",
        "ipRangeEnd": "10.0.0.255"
      }
    ],
    "v6IpAssignmentPools": [
      {
        "ipRangeStart": "10.0.0.1",
        "ipRangeEnd": "10.0.0.255"
      }
    ],
    "mtu": 2800,
    "multicastLimit": 32,
    "private": true,
    "routes": [
      {
        "target": "10.0.0.0/24"
      }
    ],
    "v4AssignmentMode": {
      "zt": true
    },
    "v6AssignmentMode": {
      "6plane": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.