network

Get a joined Network membership configuration by Network ID.

get/network/{networkID}

Request

  • Base URL
    http://localhost:9993
  • Auth
    API key in header X-ZT1-Auth

Path parameters

networkIDstring required

ID of the network to get.

Response

allowDNSboolean

Let ZeroTier modify the system's DNS settings.

allowDefaultboolean

Let ZeroTier modify the system's default route.

allowGlobalboolean

Let ZeroTier manage IP addresses and Route assignments that aren't in private ranges (rfc1918).

allowManagedboolean

Let ZeroTier to manage IP addresses and Route assignments.

assignedAddressesstring[]
bridgeboolean
broadcastEnabledboolean
idstring
macstring

MAC address for this network's interface.

mtuinteger
namestring
netconfRevisioninteger
portDeviceNamestring
portErrorinteger
statusstring
typestring

Example response

{
  "allowManaged": true,
  "assignedAddresses": [
    "10.147.20.190"
  ],
  "dns": {
    "domain": "zt.example.com",
    "servers": [
      "10.147.20.3"
    ]
  },
  "id": "565799d8f620c5c5",
  "mac": "e6:d2:2b:e6:68:73",
  "mtu": 2800,
  "multicastSubscriptions": [
    {
      "mac": "34:34:ff:da:6e:ff"
    }
  ],
  "name": "clever_krum",
  "netconfRevision": 123,
  "portDeviceName": "ztnnhrtimp",
  "routes": [
    {
      "target": "10.147.20.0/24",
      "via": "192.168.168.5"
    }
  ],
  "status": "OK",
  "type": "PRIVATE"
}

Changes

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