Modify a network member

Path Parameters

networkId string required

ID of the network

memberId string required

ID of the member

application/json

Request Body

name string

User defined name of the member

authorized boolean

Authorization status of the member

Responses

Detailed information of the specified Network Member

application/json

Schema

Example (from schema)

Example

Schema

nodeid integer

Node identifier

id string

Unique user identifier

nwid string

Network identifier

lastSeen date-time

Timestamp of last seen

online boolean

Online status

deleted boolean

Deleted status

name string

Name of the user

address string

Address of the user

creationTime integer

User creation time in milliseconds since epoch

activeBridge boolean

Active bridge status

authenticationExpiryTime integer

Authentication expiry time

authorized boolean

Authorization status

capabilities string[]

List of capabilities

identity string

User identity information

ipAssignments string[]

IP assignments

lastAuthorizedCredential string nullable

Last authorized credential

lastAuthorizedCredentialType string

Type of the last authorized credential

lastAuthorizedTime integer

Timestamp of the last authorized time

lastDeauthorizedTime integer

Timestamp of the last deauthorized time

noAutoAssignIps boolean

No auto-assign IPs status

objtype string

Object type

remoteTraceLevel integer

Remote trace level

remoteTraceTarget string nullable

Remote trace target

revision integer

Revision number

ssoExempt boolean

SSO exempt status

tags string[]

Tags associated with the user

vMajor integer

Major version number

vMinor integer

Minor version number

vProto integer

Protocol version number

vRev integer

Revision version number

physicalAddress string

External ip address of the user

peers object[]

List of peers

Array [

address string

Address of the peer

isBonded boolean

Bonded status

latency integer

Latency

paths string[]

List of paths

role string

Role of the peer

tunneled boolean

Tunneled status

version string

Version of the peer

versionMajor integer

Major version of the peer

versionMinor integer

Minor version of the peer

versionRev integer

Revision version of the peer

]

conStatus integer

Possible values: [0, 1, 2]

Connection status Possible values:

0 - Offline: The connection is not established
1 - Relayed or DirectLAN: The connection is either relayed or direct within a LAN
2 - DirectWAN: The connection is direct over WAN

{
  "nodeid": 0,
  "id": "string",
  "nwid": "string",
  "lastSeen": "2024-08-24T07:43:28.201Z",
  "online": true,
  "deleted": true,
  "name": "string",
  "address": "string",
  "creationTime": 0,
  "activeBridge": true,
  "authenticationExpiryTime": 0,
  "authorized": true,
  "capabilities": [
    "string"
  ],
  "identity": "string",
  "ipAssignments": [
    "string"
  ],
  "lastAuthorizedCredential": "string",
  "lastAuthorizedCredentialType": "string",
  "lastAuthorizedTime": 0,
  "lastDeauthorizedTime": 0,
  "noAutoAssignIps": true,
  "objtype": "string",
  "remoteTraceLevel": 0,
  "remoteTraceTarget": "string",
  "revision": 0,
  "ssoExempt": true,
  "tags": [
    "string"
  ],
  "vMajor": 0,
  "vMinor": 0,
  "vProto": 0,
  "vRev": 0,
  "physicalAddress": "string",
  "peers": [
    {
      "address": "string",
      "isBonded": true,
      "latency": 0,
      "paths": [
        "string"
      ],
      "role": "string",
      "tunneled": true,
      "version": "string",
      "versionMajor": 0,
      "versionMinor": 0,
      "versionRev": 0
    }
  ],
  "conStatus": 0
}

[
  {
    "nodeid": 1,
    "id": "abcdef01234",
    "nwid": "8056c2e21c000001",
    "lastSeen": "2023-12-09T12:06:24.529Z",
    "online": false,
    "deleted": false,
    "name": "John Doe",
    "address": "abcdef01234",
    "creationTime": 1702110030561,
    "activeBridge": false,
    "authenticationExpiryTime": 0,
    "authorized": false,
    "capabilities": [],
    "identity": "abcdef0123:0:abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123",
    "ipAssignments": [
      "10.0.0.3"
    ],
    "lastAuthorizedCredential": null,
    "lastAuthorizedCredentialType": "api",
    "lastAuthorizedTime": 1599853637989,
    "lastDeauthorizedTime": 0,
    "noAutoAssignIps": false,
    "objtype": "member",
    "remoteTraceLevel": 0,
    "remoteTraceTarget": null,
    "revision": 3,
    "ssoExempt": false,
    "tags": [],
    "vMajor": 1,
    "vMinor": 12,
    "vProto": 12,
    "vRev": 2,
    "physicalAddress": null,
    "peers": {
      "address": "abcdef01234",
      "isBonded": false,
      "latency": -1,
      "paths": [],
      "role": "LEAF",
      "tunneled": false,
      "version": "1.12.2",
      "versionMajor": 1,
      "versionMinor": 12,
      "versionRev": 2
    },
    "conStatus": 1
  },
  {
    "nodeid": 2,
    "id": "abcdef01235",
    "nwid": "8056c2e21c000001",
    "lastSeen": "2023-12-09T12:06:24.529Z",
    "online": false,
    "deleted": false,
    "name": "my-awesome-phone",
    "address": "abcdef01235",
    "creationTime": 1702110030561,
    "activeBridge": false,
    "authenticationExpiryTime": 0,
    "authorized": true,
    "capabilities": [],
    "identity": "abcdef0123:0:abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0123abcdef0124",
    "ipAssignments": [
      "10.0.0.4"
    ],
    "lastAuthorizedCredential": null,
    "lastAuthorizedCredentialType": "api",
    "lastAuthorizedTime": 1599853637989,
    "lastDeauthorizedTime": 0,
    "noAutoAssignIps": false,
    "objtype": "member",
    "remoteTraceLevel": 0,
    "remoteTraceTarget": null,
    "revision": 3,
    "ssoExempt": false,
    "tags": [],
    "vMajor": 1,
    "vMinor": 12,
    "vProto": 12,
    "vRev": 2,
    "physicalAddress": null,
    "peers": {
      "address": "abcdef01234",
      "isBonded": false,
      "latency": -1,
      "paths": [],
      "role": "LEAF",
      "tunneled": false,
      "version": "1.12.2",
      "versionMajor": 1,
      "versionMinor": 12,
      "versionRev": 2
    },
    "conStatus": 1
  }
]

Unauthorized access, indicating that the request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

Schema

Example (from schema)

missingApiKey

invalidApiKey

Schema

error string

A message detailing the reason for the unauthorized status.

{
  "error": "Unauthorized: API key is missing or invalid."
}

API key is missing

{
  "error": "Unauthorized: API key is missing."
}

API key is invalid

{
  "error": "Unauthorized: API key is invalid."
}

Rate limit exceeded, indicating that the request was not accepted because the application has exceeded the rate limit for the API.

application/json

Schema

Example (from schema)

rateLimitExceededExample

Schema

error string

A message detailing the reason for exceeding the rate limit.

{
  "error": "Rate limit exceeded. Try again in X minutes."
}

Example response for rate limit exceeded

{
  "error": "Rate limit exceeded. Try again in 1 minute."
}

Internal Server Error, indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Example (from schema)

internalServerErrorExample

Schema

error string

A message detailing the unexpected condition encountered by the server.

{
  "error": "Internal server error. Please try again later."
}

Example response for an internal server error

{
  "error": "Internal server error. Please try again later."
}

Modify a network member​

Modify a network member