Nodes
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
GET /api/nodes HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
[
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
]GET /api/nodes/{network}/{nodeid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"host": {
"autoupdate": true,
"daemoninstalled": true,
"debug": true,
"defaultinterface": "text",
"endpointip": [
1
],
"endpointipv6": [
1
],
"firewallinuse": "text",
"hostpass": "text",
"id": "text",
"interface": "text",
"interfaces": [
{
"address": {
"ip": [
1
],
"mask": [
1
]
},
"addressString": "text",
"name": "text"
}
],
"ipforwarding": true,
"isdefault": true,
"isdocker": true,
"isk8s": true,
"isstatic": true,
"isstaticport": true,
"listenport": 1,
"macaddress": [
1
],
"mtu": 1,
"name": "text",
"nat_type": "text",
"nodes": [
"text"
],
"os": "text",
"persistentkeepalive": 1,
"publickey": [
1
],
"traffickeypublic": [
1
],
"turn_endpoint": {},
"verbosity": 1,
"version": "text",
"wg_public_listen_port": 1
},
"host_peers": [
{
"allowedIPs": [
{
"ip": [
1
],
"mask": [
1
]
}
],
"endpoint": {
"ip": [
1
],
"port": 1,
"zone": "text"
},
"persistentKeepaliveInterval": 1,
"presharedKey": [
1
],
"publicKey": [
1
],
"remove": true,
"replaceAllowedIPs": true,
"updateOnly": true
}
],
"node": {
"action": "text",
"additional_rag_ips": [
1
],
"address": {
"ip": [
1
],
"mask": [
1
]
},
"address6": {
"ip": [
1
],
"mask": [
1
]
},
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayrequest": {
"natenabled": "text",
"netid": "text",
"nodeid": "text",
"ranges": [
"text"
],
"ranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
]
},
"expdatetime": "text",
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressgatewayrange": "text",
"ingressgatewayrange6": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_gw": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": "text",
"lastmodified": "text",
"lastpeerupdate": "text",
"localaddress": {
"ip": [
1
],
"mask": [
1
]
},
"metadata": "text",
"network": "text",
"networkrange": 1,
"networkrange6": 1,
"node_status": "online",
"ownerid": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"peerids": {
"ANY_ADDITIONAL_PROPERTY": {
"address": "text",
"host_id": "text",
"id": "text",
"is_extclient": true,
"isserver": "text",
"listen_port": 1,
"name": "text",
"network": "text"
}
},
"peers": [
{
"allowedIPs": [
{
"ip": [
1
],
"mask": [
1
]
}
],
"endpoint": {
"ip": [
1
],
"port": 1,
"zone": "text"
},
"persistentKeepaliveInterval": 1,
"presharedKey": [
1
],
"publicKey": [
1
],
"remove": true,
"replaceAllowedIPs": true,
"updateOnly": true
}
],
"serverconfig": {
"Is_EE": true,
"api": "text",
"apiport": "text",
"broker": "text",
"brokerType": "text",
"coreDNSAddr": "text",
"defaultDomain": "text",
"dnsmode": "text",
"endpointDetection": true,
"manageDNS": true,
"metricInterval": "text",
"metricsPort": 1,
"mqpassword": "text",
"mqport": "text",
"mquserName": "text",
"server": "text",
"stun": true,
"stunServers": "text",
"trafficKey": [
1
],
"version": "text"
}
}PUT /api/nodes/{network}/{nodeid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}DELETE /api/nodes/{network}/{nodeid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
textPOST /api/nodes/{network}/{nodeid}/creategateway HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}DELETE /api/nodes/{network}/{nodeid}/deletegateway HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}POST /api/nodes/{network}/{nodeid}/gateway HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}DELETE /api/nodes/{network}/{nodeid}/gateway HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}GET /api/nodes/adm/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
[
{
"action": "text",
"additional_rag_ips": [
1
],
"address": {
"ip": [
1
],
"mask": [
1
]
},
"address6": {
"ip": [
1
],
"mask": [
1
]
},
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayrequest": {
"natenabled": "text",
"netid": "text",
"nodeid": "text",
"ranges": [
"text"
],
"ranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
]
},
"expdatetime": "text",
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressgatewayrange": "text",
"ingressgatewayrange6": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_gw": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": "text",
"lastmodified": "text",
"lastpeerupdate": "text",
"localaddress": {
"ip": [
1
],
"mask": [
1
]
},
"metadata": "text",
"network": "text",
"networkrange": 1,
"networkrange6": 1,
"node_status": "online",
"ownerid": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
]DELETE /api/v1/legacy/nodes HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
textGET /api/v1/nodes/{network}/status HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
[
{
"additional_rag_ips": [
"text"
],
"address": "text",
"address6": "text",
"allowedips": [
"text"
],
"connected": true,
"defaultacl": "text",
"dnson": true,
"egressgatewaynatenabled": true,
"egressgatewayranges": [
"text"
],
"egressgatewayranges_with_metric": [
{
"network": "text",
"route_metric": 1
}
],
"expdatetime": 1,
"fail_over_peers": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"failed_over_by": "text",
"hostid": "text",
"id": "text",
"inet_node_req": {
"inet_node_client_ids": [
"text"
]
},
"ingressdns": "text",
"ingressmtu": 1,
"ingresspersistentkeepalive": 1,
"internetgw_node_id": "text",
"is_fail_over": true,
"is_static": true,
"is_user_node": true,
"isegressgateway": true,
"isingressgateway": true,
"isinternetgateway": true,
"isrelay": true,
"isrelayed": true,
"lastcheckin": 1,
"lastmodified": 1,
"lastpeerupdate": 1,
"localaddress": "text",
"metadata": "text",
"network": "text",
"networkrange": "text",
"networkrange6": "text",
"pendingdelete": true,
"relayedby": "text",
"relaynodes": [
"text"
],
"server": "text",
"static_node": {
"address": "text",
"address6": "text",
"allowed_ips": [
"text"
],
"clientid": "text",
"country": "text",
"deniednodeacls": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"device_name": "text",
"dns": "text",
"enabled": true,
"extraallowedips": [
"text"
],
"ingressgatewayendpoint": "text",
"ingressgatewayid": "text",
"lastmodified": 1,
"network": "text",
"os": "text",
"ownerid": "text",
"postdown": "text",
"postup": "text",
"privatekey": "text",
"public_endpoint": "text",
"publickey": "text",
"remote_access_client_id": "text",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"status": "online",
"tags": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
]