ZeroTier One Network Virtualization Service ====== This is the common background service implementation for ZeroTier One, the VPN-like OS-level network virtualization service. It provides a ready-made core I/O loop and a local HTTP-based JSON control bus for controlling the service. This control bus HTTP server can also serve the files in ui/ if this folder's contents are installed in the ZeroTier home folder. The ui/ implements a React-based HTML5 user interface which is then wrappered for various platforms via MacGap, Windows .NET WebControl, etc. It can also be used locally from scripts or via *curl*. ### Network Virtualization Service API The JSON API supports GET, POST/PUT, and DELETE. PUT is treated as a synonym for POST. Other methods including HEAD are not supported. Values POSTed to the JSON API are *extremely* type sensitive. Things *must* be of the indicated type, otherwise they will be ignored or will generate an error. Anything quoted is a string so booleans and integers must lack quotes. Booleans must be *true* or *false* and nothing else. Integers cannot contain decimal points or they are floats (and vice versa). If something seems to be getting ignored or set to a strange value, or if you receive errors, check the type of all JSON fields you are submitting against the types listed below. Unrecognized fields in JSON objects are also ignored. API requests must be authenticated via an authentication token. ZeroTier One saves this token in the *authtoken.secret* file in its working directory. This token may be supplied via the *auth* URL parameter (e.g. '?auth=...') or via the *X-ZT1-Auth* HTTP request header. Static UI pages are the only thing the server will allow without authentication. A *jsonp* URL argument may be supplied to request JSONP encapsulation. A JSONP response is sent as a script with its JSON response payload wrapped in a call to the function name supplied as the argument to *jsonp*. #### /status * Purpose: Get running node status and addressing info * Methods: GET * Returns: { object }
Field | Type | Description | Writable |
address | string | 10-digit hexadecimal ZeroTier address of this node | no |
publicIdentity | string | Full public ZeroTier identity of this node | no |
online | boolean | Does this node appear to have upstream network access? | no |
tcpFallbackActive | boolean | Is TCP fallback mode active? | no |
versionMajor | integer | ZeroTier major version | no |
versionMinor | integer | ZeroTier minor version | no |
versionRev | integer | ZeroTier revision | no |
version | string | Version in major.minor.rev format | no |
clock | integer | Node system clock in ms since epoch | no |
Field | Type | Description | Writable |
Field | Type | Description | Writable |
nwid | string | 16-digit hex network ID | no |
mac | string | Ethernet MAC address of virtual network port | no |
name | string | Network short name as configured on network controller | no |
status | string | Network status: OK, ACCESS_DENIED, PORT_ERROR, etc. | no |
type | string | Network type, currently PUBLIC or PRIVATE | no |
mtu | integer | Ethernet MTU | no |
dhcp | boolean | If true, DHCP may be used to obtain an IP address | no |
bridge | boolean | If true, this node may bridge in other Ethernet devices | no |
broadcastEnabled | boolean | Is Ethernet broadcast (ff:ff:ff:ff:ff:ff) allowed? | no |
portError | integer | Error code (if any) returned by underlying OS "tap" driver | no |
netconfRevision | integer | Network configuration revision ID | no |
multicastSubscriptions | [string] | Multicast memberships as array of MAC/ADI tuples | no |
assignedAddresses | [string] | ZeroTier-managed IP address assignments as array of IP/netmask bits tuples | no |
portDeviceName | string | OS-specific network device name (if available) | no |
Field | Type | Description | Writable |
address | string | 10-digit hex ZeroTier address | no |
lastUnicastFrame | integer | Time of last unicast frame in ms since epoch | no |
lastMulticastFrame | integer | Time of last multicast frame in ms since epoch | no |
versionMajor | integer | Major version of remote if known | no |
versionMinor | integer | Minor version of remote if known | no |
versionRev | integer | Revision of remote if known | no |
version | string | Version in major.minor.rev format | no |
latency | integer | Latency in milliseconds if known | no |
role | string | LEAF, HUB, or SUPERNODE | no |
paths | [object] | Array of path objects (see below) | no |
Field | Type | Description | Writable |
address | string | Physical socket address e.g. IP/port for UDP | no |
lastSend | integer | Last send via this path in ms since epoch | no |
lastReceive | integer | Last receive via this path in ms since epoch | no |
fixed | boolean | If true, this is a statically-defined "fixed" path | no |
preferred | boolean | If true, this is the current preferred path | no |
Field | Type | Description | Writable |
controller | boolean | Always 'true' if controller is running | no |
apiVersion | integer | JSON API version, currently 1 | no |
clock | integer | Controller system clock in ms since epoch | no |
Field | Type | Description | Writable |
nwid | string | 16-digit hex network ID | no |
name | string | Short network name (max: 127 chars) | yes |
private | boolean | False if public network, true for access control | yes |
enableBroadcast | boolean | True to allow Ethernet broadcast (ff:ff:ff:ff:ff:ff) | yes |
allowPassiveBridging | boolean | True to allow any member to bridge (experimental!) | yes |
v4AssignMode | string | 'none', 'zt', or 'dhcp' (see below) | yes |
v6AssignMode | string | 'none', 'zt', or 'dhcp' (see below) | yes |
multicastLimit | integer | Maximum number of multicast recipients per multicast/broadcast address | yes |
creationTime | integer | Time network was created in ms since epoch | no |
revision | integer | Network config revision number | no |
members | [string] | Array of ZeroTier addresses of network members | no |
relays | [object] | Array of network-specific relay nodes (see below) | yes |
ipAssignmentPools | [object] | Array of IP auto-assignment pools for 'zt' assignment mode | yes |
rules | [object] | Array of network flow rules (see below) | yes |
Field | Type | Description |
address | string | 10-digit ZeroTier address of relay node |
phyAddress | string | Fixed path address in IP/port format e.g. 192.168.1.1/9993 |
Field | Type | Description |
network | string | IP network e.g. 192.168.0.0 |
netmaskBits | integer | IP network netmask bits e.g. 16 for 255.255.0.0 |
Field | Type | Description |
ruleId | integer | User-defined rule ID and sort order |
nodeId | string | 10-digit hex ZeroTier address of node (a.k.a. "port on switch") |
vlanId | integer | Ethernet VLAN ID |
vlanPcp | integer | Ethernet VLAN priority code point (PCP) ID |
etherType | integer | Ethernet frame type |
macSource | string | Ethernet source MAC address |
macDest | string | Ethernet destination MAC address |
ipSource | string | Source IP address |
ipDest | string | Destination IP address |
ipTos | integer | IP TOS field |
ipProtocol | integer | IP protocol |
ipSourcePort | integer | IP source port |
ipDestPort | integer | IP destination port |
action | string | Rule action: accept, drop, etc. |
Field | Type | Description | Writable |
nwid | string | 16-digit hex network ID | no |
address | string | 10-digit hex ZeroTier address | no |
authorized | boolean | Is member authorized? | yes |
activeBridge | boolean | This member is an active network bridge | yes |
lastAt | string | Socket address (e.g. IP/port) where member was last seen | no |
lastSeen | integer | Timestamp of member's last request in ms since epoch | no |
firstSeen | integer | Timestamp member was first seen in ms since epoch | no |
identity | string | Full ZeroTier identity of member | no |
ipAssignments | [string] | Array of IP/bits IP assignments | yes |