network-member

Modify a network member

post/network/{networkID}/member/{memberID}

Request

Base URL
https://api.zerotier.com/api/v1
Auth
HTTP token

Path parameters

networkIDstring required

ID of the network

memberIDstring required

ID of the member

Request body

idstring nullable

concatenation of network ID and member ID

clockinteger nullable

networkIdstring nullable

nodeIdstring nullable

ZeroTier ID of the member

controllerIdstring nullable

hiddenboolean nullable

Whether or not the member is hidden in the UI

namestring nullable

User defined name of the member

descriptionstring nullable

User defined description of the member

lastOnlineinteger nullable

Last seen time of the member (milliseconds since epoch). Note: This data is considered ephemeral and may be reset to 0 at any time without warning.

lastSeeninteger nullable

Time the member last checked in with the network controller in milliseconds since epoch. Note: This data is considered ephemeral and may be reset to 0 at any time without warning.

physicalAddressstring nullable

IP address the member last spoke to the controller via (milliseconds since epoch). Note: This data is considered ephemeral and may be reset to 0 at any time without warning.

clientVersionstring nullable

ZeroTier version the member is running

protocolVersioninteger nullable

ZeroTier protocol version

supportsRulesEngineboolean nullable

Whether or not the client version is new enough to support the rules engine (1.4.0+)

Example request

{
  "id": "8056c2e21c000001-abcdef0123",
  "clock": 1612993759070,
  "networkId": "8056c2e21c000001",
  "nodeId": "abcdef01234",
  "controllerId": "8056c2e21c",
  "name": "my-cray-supercomputer",
  "description": "My super awesome cray that I got ZeroTier to run on",
  "config": {
    "authorized": true,
    "creationTime": 1599853509872,
    "id": "abcdef01234",
    "identity": "abcdef0123:0:abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123",
    "ipAssignments": [
      "10.0.0.3"
    ],
    "lastAuthorizedTime": 1599853637989,
    "revision": 123,
    "tags": [
      [
        123,
        456
      ]
    ],
    "vMajor": 1,
    "vMinor": 6,
    "vRev": 3,
    "vProto": 12
  },
  "lastOnline": 1612993673254,
  "lastSeen": 1612993673254,
  "physicalAddress": "8.8.8.8",
  "clientVersion": "1.6.3",
  "protocolVersion": 12
}

Response

member changed successfully