Skip to content

Updates a Netclient host on Netmaker server

PUT
/api/v1/fallback/host/{hostid}

Authorizations

Parameters

Path Parameters

hostid
required
string

Host ID

Request Body

Host update data

object
action
string
Allowed values: UPGRADE SIGNAL_HOST UPDATE_HOST DELETE_HOST JOIN_HOST_TO_NETWORK ACK REQ_ACK CHECK_IN UPDATE_KEYS REQ_PULL SIGNAL_PULL UPDATE_METRICS
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
newMetrics
object
connectivity
object
key
additional properties
object
actualuptime
integer
connected
boolean
latency
integer
node_name
string
percentup
number
totalreceived
integer
totalsent
integer
totaltime
integer
uptime
integer
network
string
node_id
string
node_name
string
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
signal
object
action
string
Allowed values: CONNECTION_NEGOTIATION RELAY_ME
from_host_id
string
from_host_pubkey
string
from_node_id
string
is_pro
boolean
reply
boolean
server
string
timestamp
integer
to_host_id
string
to_host_pubkey
string
to_node_id
string

Responses

200

Updated host data

string

500

Internal Server Error

object
code
integer
message
string