Hosts

List all hosts

get
Authorizations
Responses
chevron-right
200

OK

application/json
autoupdatebooleanOptional
country_codestringOptional
debugbooleanOptional
defaultinterfacestringOptional
dnsstringOptional
enable_flow_logsbooleanOptional
endpointipstringOptional
endpointipv6stringOptional
firewallinusestringOptional
idstringOptional
isdefaultbooleanOptional
isstaticbooleanOptional
isstaticportbooleanOptional
kernel_versionstringOptional
listenportintegerOptional
locationstringOptional
macaddressstringOptional
mtuintegerOptional
namestringOptional
nat_typestringOptional
nodesstring[]Optional
osstringOptional
os_familystringOptional
os_versionstringOptional
persistentkeepaliveintegerOptional
publickeystringOptional
verbosityintegerOptional
versionstringOptional
wg_public_listen_portintegerOptional
get
/api/hosts

Updates a Netclient host on Netmaker server

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Body
autoupdatebooleanOptional
country_codestringOptional
debugbooleanOptional
defaultinterfacestringOptional
dnsstringOptional
enable_flow_logsbooleanOptional
endpointipstringOptional
endpointipv6stringOptional
firewallinusestringOptional
idstringOptional
isdefaultbooleanOptional
isstaticbooleanOptional
isstaticportbooleanOptional
kernel_versionstringOptional
listenportintegerOptional
locationstringOptional
macaddressstringOptional
mtuintegerOptional
namestringOptional
nat_typestringOptional
nodesstring[]Optional
osstringOptional
os_familystringOptional
os_versionstringOptional
persistentkeepaliveintegerOptional
publickeystringOptional
verbosityintegerOptional
versionstringOptional
wg_public_listen_portintegerOptional
Responses
chevron-right
200

OK

application/json
autoupdatebooleanOptional
country_codestringOptional
debugbooleanOptional
defaultinterfacestringOptional
dnsstringOptional
enable_flow_logsbooleanOptional
endpointipstringOptional
endpointipv6stringOptional
firewallinusestringOptional
idstringOptional
isdefaultbooleanOptional
isstaticbooleanOptional
isstaticportbooleanOptional
kernel_versionstringOptional
listenportintegerOptional
locationstringOptional
macaddressstringOptional
mtuintegerOptional
namestringOptional
nat_typestringOptional
nodesstring[]Optional
osstringOptional
os_familystringOptional
os_versionstringOptional
persistentkeepaliveintegerOptional
publickeystringOptional
verbosityintegerOptional
versionstringOptional
wg_public_listen_portintegerOptional
put
/api/hosts/{hostid}

Deletes a Netclient host from Netmaker server

delete
Authorizations
Path parameters
hostidstringRequired

Host ID

Query parameters
forcebooleanOptional

Force delete

Responses
chevron-right
200

OK

application/json
autoupdatebooleanOptional
country_codestringOptional
debugbooleanOptional
defaultinterfacestringOptional
dnsstringOptional
enable_flow_logsbooleanOptional
endpointipstringOptional
endpointipv6stringOptional
firewallinusestringOptional
idstringOptional
isdefaultbooleanOptional
isstaticbooleanOptional
isstaticportbooleanOptional
kernel_versionstringOptional
listenportintegerOptional
locationstringOptional
macaddressstringOptional
mtuintegerOptional
namestringOptional
nat_typestringOptional
nodesstring[]Optional
osstringOptional
os_familystringOptional
os_versionstringOptional
persistentkeepaliveintegerOptional
publickeystringOptional
verbosityintegerOptional
versionstringOptional
wg_public_listen_portintegerOptional
delete
/api/hosts/{hostid}

Update keys for a host

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
chevron-right
200

OK

application/json
stringOptional
put
/api/hosts/{hostid}/keys

To Add Host To Network

post
Authorizations
Path parameters
hostidstringRequired

Host ID

networkstringRequired

Network name

Responses
chevron-right
200

OK

application/json
stringOptional
post
/api/hosts/{hostid}/networks/{network}

To Remove Host from Network

delete
Authorizations
Path parameters
hostidstringRequired

Host ID

networkstringRequired

Network name

Query parameters
forcebooleanOptional

Force delete

Responses
chevron-right
200

OK

application/json
stringOptional
delete
/api/hosts/{hostid}/networks/{network}

Requests a host to pull

post
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
chevron-right
200

OK

application/json
stringOptional
post
/api/hosts/{hostid}/sync

Upgrade a host

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Query parameters
forcebooleanOptional

Force upgrade

Responses
chevron-right
200

passed message to upgrade host

application/json
stringOptional
put
/api/hosts/{hostid}/upgrade

Update keys for all hosts

put
Authorizations
Responses
chevron-right
200

OK

application/json
stringOptional
put
/api/hosts/keys

Requests all the hosts to pull

post
Authorizations
Responses
chevron-right
200

sync all hosts request received

application/json
stringOptional
post
/api/hosts/sync
200

sync all hosts request received

Requests all the hosts to upgrade their version

post
Authorizations
Query parameters
forcebooleanOptional

Force upgrade

Responses
chevron-right
200

upgrade all hosts request received

application/json
stringOptional
post
/api/hosts/upgrade
200

upgrade all hosts request received

Updates a Netclient host on Netmaker server

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Body
actionstring · enumOptionalPossible values:
Responses
chevron-right
200

updated host data

application/json
stringOptional
put
/api/v1/fallback/host/{hostid}

Used by clients for "pull" command

get
Authorizations
Responses
chevron-right
200

OK

application/json
change_default_gwbooleanOptional
default_gw_ipinteger[]Optional
endpoint_detectionbooleanOptional
is_inet_gwbooleanOptional
name_serversstring[]Optional
replace_peersbooleanOptional
get
/api/v1/host

Fetches host peerinfo

get
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
chevron-right
200

OK

application/json
get
/api/v1/host/{hostid}/peer_info

Send signal to peer

post
Authorizations
Path parameters
hostidstringRequired

Host ID

Body
actionstring · enumOptionalPossible values:
from_host_idstringOptional
from_host_pubkeystringOptional
from_node_idstringOptional
is_probooleanOptional
networkIDstringOptional
replybooleanOptional
serverstringOptional
timestampintegerOptional
to_host_idstringOptional
to_host_pubkeystringOptional
to_node_idstringOptional
Responses
chevron-right
200

OK

application/json
actionstring · enumOptionalPossible values:
from_host_idstringOptional
from_host_pubkeystringOptional
from_node_idstringOptional
is_probooleanOptional
networkIDstringOptional
replybooleanOptional
serverstringOptional
timestampintegerOptional
to_host_idstringOptional
to_host_pubkeystringOptional
to_node_idstringOptional
post
/api/v1/host/{hostid}/signalpeer

List pending hosts in a network

get
Authorizations
Query parameters
networkstringRequired

Network ID

Responses
chevron-right
200

OK

application/json
enrollment_key_idinteger[]Optional
host_idstringOptional
host_namestringOptional
idstringOptional
locationstringOptional

Format: "lat,lon"

networkstringOptional
osstringOptional
public_keystringOptional
requested_atstringOptional
versionstringOptional
get
/api/v1/pending_hosts

Approve pending host in a network

post
Authorizations
Path parameters
idstringRequired

Pending Host ID

Responses
chevron-right
200

OK

application/json
additional_rag_ipsstring[]Optional
addressstringOptional
address6stringOptional
allowedipsstring[]Optional
auto_assign_gwbooleanOptional
connectedbooleanOptional
countrystringOptional
defaultaclstringOptional

== PRO ==

dnsonbooleanOptional
egressgatewaynatenabledbooleanOptional
egressgatewayrangesstring[]Optional
expdatetimeinteger · int64Optional
failed_over_bystringOptional
hostidstring · min: 5Required
idstring · min: 5Required
ingressdnsstringOptional
ingressmtuintegerOptional
ingresspersistentkeepaliveintegerOptional
internetgw_node_idstringOptional
is_auto_relaybooleanOptional
is_fail_overbooleanOptional
is_gwbooleanOptional
is_staticbooleanOptional
is_user_nodebooleanOptional
isegressgatewaybooleanOptional
isingressgatewaybooleanOptional
isinternetgatewaybooleanOptional
isrelaybooleanOptional
isrelayedbooleanOptional
last_evaluated_atstringOptional
lastcheckininteger · int64Optional
lastmodifiedinteger · int64Optional
lastpeerupdateinteger · int64Optional
localaddressstringOptional
locationstringOptional
metadatastringOptional
networkstringOptional
networkrangestringOptional
networkrange6stringOptional
pendingdeletebooleanOptional
posture_check_violation_severity_levelinteger · enumOptionalPossible values:
relayedbystringOptional

AutoRelayedBy uuid.UUID json:"auto_relayed_by"

relaynodesstring[]Optional
serverstringOptional
statusstring · enumOptionalPossible values:
post
/api/v1/pending_hosts/approve/{id}

Reject pending host in a network

post
Authorizations
Path parameters
idstringRequired

Pending Host ID

Responses
chevron-right
200

OK

application/json
enrollment_key_idinteger[]Optional
host_idstringOptional
host_namestringOptional
idstringOptional
locationstringOptional

Format: "lat,lon"

networkstringOptional
osstringOptional
public_keystringOptional
requested_atstringOptional
versionstringOptional
post
/api/v1/pending_hosts/reject/{id}

Last updated

Was this helpful?