Skip to content

Get an individual node

GET
/api/nodes/{network}/{nodeid}

Authorizations

Responses

200

OK

object
host
object
autoupdate
boolean
daemoninstalled
boolean
debug
boolean
defaultinterface
string
endpointip
Array<integer>
endpointipv6
Array<integer>
firewallinuse
string
hostpass
string
id
string
interface
string
interfaces
Array<object>
object
address
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
addressString
string
name
string
ipforwarding
boolean
isdefault
boolean
isdocker
boolean
isk8s
boolean
isstatic
boolean
isstaticport
boolean
listenport
integer
macaddress
Array<integer>
mtu
integer
name
string
nat_type
string
nodes
Array<string>
os
string
persistentkeepalive
integer
publickey
Array<integer>
traffickeypublic
Array<integer>
turn_endpoint
object
verbosity
integer
version
string
wg_public_listen_port
integer
host_peers
Array<object>
object
allowedIPs

AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.

Array<object>
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
endpoint

Endpoint specifies the endpoint of this peer entry, if not nil.

object
ip
Array<integer>
port
integer
zone

IPv6 scoped addressing zone

string
persistentKeepaliveInterval

PersistentKeepaliveInterval specifies the persistent keepalive interval for this peer, if not nil.

A non-nil value of 0 will clear the persistent keepalive interval.

integer
presharedKey

PresharedKey specifies a peer’s preshared key configuration, if not nil.

A non-nil, zero-value Key will clear the preshared key.

Array<integer>
publicKey

PublicKey specifies the public key of this peer. PublicKey is a mandatory field for all PeerConfigs.

Array<integer>
remove

Remove specifies if the peer with this public key should be removed from a device’s peer list.

boolean
replaceAllowedIPs

ReplaceAllowedIPs specifies if the allowed IPs specified in this peer configuration should replace any existing ones, instead of appending them to the allowed IPs list.

boolean
updateOnly

UpdateOnly specifies that an operation will only occur on this peer if the peer already exists as part of the interface.

boolean
node
object
action
string
additional_rag_ips
Array<number>
address
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
address6
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
connected
boolean
defaultacl

== PRO ==

string
dnson
boolean
egressgatewaynatenabled
boolean
egressgatewayranges
Array<string>
egressgatewayrequest
object
natenabled
string
netid
string
nodeid
string
ranges
Array<string>
expdatetime
string
fail_over_peers
object
key
additional properties
object
failed_over_by
string
hostid
string
id
string
inet_node_req
object
inet_node_client_ids
Array<string>
ingressdns
string
ingressgatewayrange
string
ingressgatewayrange6
string
internetgw_node_id
string
is_fail_over
boolean
isegressgateway
boolean
isingressgateway
boolean
isinternetgateway
boolean
isrelay
boolean
isrelayed
boolean
lastcheckin
string
lastmodified
string
lastpeerupdate
string
localaddress
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
metadata
string
network
string
networkrange
integer
networkrange6
number
ownerid
string
pendingdelete
boolean
relayedby
string
relaynodes
Array<string>
server
string
peerids
object
key
additional properties
object
address
string
host_id
string
id
string
is_extclient
boolean
isserver
string
listen_port
integer
name
string
network
string
peers
Array<object>
object
allowedIPs

AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.

Array<object>
object
ip

Network number

Array<integer>
mask

Network mask

Array<integer>
endpoint

Endpoint specifies the endpoint of this peer entry, if not nil.

object
ip
Array<integer>
port
integer
zone

IPv6 scoped addressing zone

string
persistentKeepaliveInterval

PersistentKeepaliveInterval specifies the persistent keepalive interval for this peer, if not nil.

A non-nil value of 0 will clear the persistent keepalive interval.

integer
presharedKey

PresharedKey specifies a peer’s preshared key configuration, if not nil.

A non-nil, zero-value Key will clear the preshared key.

Array<integer>
publicKey

PublicKey specifies the public key of this peer. PublicKey is a mandatory field for all PeerConfigs.

Array<integer>
remove

Remove specifies if the peer with this public key should be removed from a device’s peer list.

boolean
replaceAllowedIPs

ReplaceAllowedIPs specifies if the allowed IPs specified in this peer configuration should replace any existing ones, instead of appending them to the allowed IPs list.

boolean
updateOnly

UpdateOnly specifies that an operation will only occur on this peer if the peer already exists as part of the interface.

boolean
serverconfig
object
Is_EE
boolean
api
string
apiport
string
broker
string
brokerType
string
coreDNSAddr
string
dnsmode
string
metricInterval
string
mqpassword
string
mqport
string
mquserName
string
server
string
trafficKey
Array<integer>
version
string

500

Internal Server Error

object
code
integer
message
string