Skip to content

Handles a Netclient registration with server and add nodes accordingly

POST
/api/v1/host/register/{token}

Authorizations

Parameters

Path Parameters

token
required
string

Enrollment Key Token

Request Body

Host registration parameters

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

Responses

200

OK

object
requested_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
server_config
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

400

Bad Request

object
code
integer
message
string

500

Internal Server Error

object
code
integer
message
string