Hosts

Deletes all EMQX hosts

delete
Authorizations
Responses
chevron-right
200

deleted hosts data on emqx

application/json
Responsestring
delete
/api/emqx/hosts

Fetches host peerinfo

get
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
chevron-right
200

OK

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

List all hosts

get
Authorizations
Responses
chevron-right
200

OK

application/json
get
/api/hosts

Updates a Netclient host on Netmaker server

put
Authorizations
Path parameters
hostidstringRequired

Host ID

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

OK

application/json
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
delete
/api/hosts/{hostid}

Update keys for a host

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
chevron-right
200

OK

application/json
Responsestring
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
Responsestring
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
Responsestring
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
Responsestring
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
Responsestring
put
/api/hosts/{hostid}/upgrade

Update keys for all hosts

put
Authorizations
Responses
chevron-right
200

OK

application/json
Responsestring
put
/api/hosts/keys

Requests all the hosts to pull

post
Authorizations
Responses
chevron-right
200

sync all hosts request received

application/json
Responsestring
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
Responsestring
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
Responsestring
put
/api/v1/fallback/host/{hostid}

Used by clients for "pull" command

get
Authorizations
Responses
chevron-right
200

OK

application/json
get
/api/v1/host

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
replybooleanOptional
serverstringOptional
timestampintegerOptional
to_host_idstringOptional
to_host_pubkeystringOptional
to_node_idstringOptional
Responses
chevron-right
200

OK

application/json
post
/api/v1/host/{hostid}/signalpeer

Last updated

Was this helpful?