Ctrlk
APIGitHubYouTubeCommunityWebsite
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Hosts

List all hosts

get
Authorizations
Responses
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
GET /api/hosts HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "autoupdate": true,
    "country_code": "text",
    "debug": true,
    "defaultinterface": "text",
    "dns": "text",
    "enable_flow_logs": true,
    "endpointip": "text",
    "endpointipv6": "text",
    "firewallinuse": "text",
    "id": "text",
    "interfaces": [
      {
        "addressString": "text",
        "name": "text"
      }
    ],
    "isdefault": true,
    "isstatic": true,
    "isstaticport": true,
    "kernel_version": "text",
    "listenport": 1,
    "location": "text",
    "macaddress": "text",
    "mtu": 1,
    "name": "text",
    "nat_type": "text",
    "nodes": [
      "text"
    ],
    "os": "text",
    "os_family": "text",
    "os_version": "text",
    "persistentkeepalive": 1,
    "publickey": "text",
    "verbosity": 1,
    "version": "text",
    "wg_public_listen_port": 1
  }
]

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
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}
PUT /api/hosts/{hostid} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 586

{
  "autoupdate": true,
  "country_code": "text",
  "debug": true,
  "defaultinterface": "text",
  "dns": "text",
  "enable_flow_logs": true,
  "endpointip": "text",
  "endpointipv6": "text",
  "firewallinuse": "text",
  "id": "text",
  "interfaces": [
    {
      "addressString": "text",
      "name": "text"
    }
  ],
  "isdefault": true,
  "isstatic": true,
  "isstaticport": true,
  "kernel_version": "text",
  "listenport": 1,
  "location": "text",
  "macaddress": "text",
  "mtu": 1,
  "name": "text",
  "nat_type": "text",
  "nodes": [
    "text"
  ],
  "os": "text",
  "os_family": "text",
  "os_version": "text",
  "persistentkeepalive": 1,
  "publickey": "text",
  "verbosity": 1,
  "version": "text",
  "wg_public_listen_port": 1
}
{
  "autoupdate": true,
  "country_code": "text",
  "debug": true,
  "defaultinterface": "text",
  "dns": "text",
  "enable_flow_logs": true,
  "endpointip": "text",
  "endpointipv6": "text",
  "firewallinuse": "text",
  "id": "text",
  "interfaces": [
    {
      "addressString": "text",
      "name": "text"
    }
  ],
  "isdefault": true,
  "isstatic": true,
  "isstaticport": true,
  "kernel_version": "text",
  "listenport": 1,
  "location": "text",
  "macaddress": "text",
  "mtu": 1,
  "name": "text",
  "nat_type": "text",
  "nodes": [
    "text"
  ],
  "os": "text",
  "os_family": "text",
  "os_version": "text",
  "persistentkeepalive": 1,
  "publickey": "text",
  "verbosity": 1,
  "version": "text",
  "wg_public_listen_port": 1
}

Deletes a Netclient host from Netmaker server

delete
Authorizations
Path parameters
hostidstringRequired

Host ID

Query parameters
forcebooleanOptional

Force delete

Responses
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}
DELETE /api/hosts/{hostid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "autoupdate": true,
  "country_code": "text",
  "debug": true,
  "defaultinterface": "text",
  "dns": "text",
  "enable_flow_logs": true,
  "endpointip": "text",
  "endpointipv6": "text",
  "firewallinuse": "text",
  "id": "text",
  "interfaces": [
    {
      "addressString": "text",
      "name": "text"
    }
  ],
  "isdefault": true,
  "isstatic": true,
  "isstaticport": true,
  "kernel_version": "text",
  "listenport": 1,
  "location": "text",
  "macaddress": "text",
  "mtu": 1,
  "name": "text",
  "nat_type": "text",
  "nodes": [
    "text"
  ],
  "os": "text",
  "os_family": "text",
  "os_version": "text",
  "persistentkeepalive": 1,
  "publickey": "text",
  "verbosity": 1,
  "version": "text",
  "wg_public_listen_port": 1
}

Update keys for a host

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
200

OK

application/json
stringOptional
put/api/hosts/{hostid}/keys
PUT /api/hosts/{hostid}/keys HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

To Add Host To Network

post
Authorizations
Path parameters
hostidstringRequired

Host ID

networkstringRequired

Network name

Responses
200

OK

application/json
stringOptional
post/api/hosts/{hostid}/networks/{network}
POST /api/hosts/{hostid}/networks/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

To Remove Host from Network

delete
Authorizations
Path parameters
hostidstringRequired

Host ID

networkstringRequired

Network name

Query parameters
forcebooleanOptional

Force delete

Responses
200

OK

application/json
stringOptional
delete/api/hosts/{hostid}/networks/{network}
DELETE /api/hosts/{hostid}/networks/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Requests a host to pull

post
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
200

OK

application/json
stringOptional
post/api/hosts/{hostid}/sync
POST /api/hosts/{hostid}/sync HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Upgrade a host

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Query parameters
forcebooleanOptional

Force upgrade

Responses
200

passed message to upgrade host

application/json
stringOptional
put/api/hosts/{hostid}/upgrade
PUT /api/hosts/{hostid}/upgrade HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Update keys for all hosts

put
Authorizations
Responses
200

OK

application/json
stringOptional
put/api/hosts/keys
PUT /api/hosts/keys HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Requests all the hosts to pull

post
Authorizations
Responses
200

sync all hosts request received

application/json
stringOptional
post/api/hosts/sync
POST /api/hosts/sync HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
200

sync all hosts request received

text

Requests all the hosts to upgrade their version

post
Authorizations
Query parameters
forcebooleanOptional

Force upgrade

Responses
200

upgrade all hosts request received

application/json
stringOptional
post/api/hosts/upgrade
POST /api/hosts/upgrade HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
200

upgrade all hosts request received

text

Updates a Netclient host on Netmaker server

put
Authorizations
Path parameters
hostidstringRequired

Host ID

Body
actionstring · enumOptionalPossible values:
Responses
200

updated host data

application/json
stringOptional
put/api/v1/fallback/host/{hostid}
PUT /api/v1/fallback/host/{hostid} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 7097

{
  "action": "UPGRADE",
  "egressDomain": {
    "domain": "text",
    "host": {
      "autoupdate": true,
      "country_code": "text",
      "daemoninstalled": true,
      "debug": true,
      "defaultinterface": "text",
      "dns_status": "text",
      "enable_flow_logs": true,
      "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,
      "kernel_version": "text",
      "listenport": 1,
      "location": "text",
      "macaddress": [
        1
      ],
      "mtu": 1,
      "name": "text",
      "nat_type": "text",
      "nodes": [
        "text"
      ],
      "os": "text",
      "os_family": "text",
      "os_version": "text",
      "persistentkeepalive": 1,
      "publickey": [
        1
      ],
      "traffickeypublic": [
        1
      ],
      "turn_endpoint": {},
      "verbosity": 1,
      "version": "text",
      "wg_public_listen_port": 1
    },
    "id": "text",
    "node": {
      "action": "text",
      "additional_rag_ips": [
        1
      ],
      "address": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "address6": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "auto_assign_gw": true,
      "auto_relayed_peers_v1": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "connected": true,
      "country_code": "text",
      "defaultacl": "text",
      "egressgatewaynatenabled": true,
      "egressgatewayranges": [
        "text"
      ],
      "egressgatewayrequest": {
        "natenabled": "text",
        "netid": "text",
        "nodeid": "text",
        "ranges": [
          "text"
        ],
        "ranges_with_metric": [
          {
            "nat": true,
            "nat_mode": "virtual_nat",
            "network": "text",
            "route_metric": 1,
            "virtual_network": "text"
          }
        ]
      },
      "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_auto_relay": true,
      "is_fail_over": true,
      "is_gw": true,
      "is_static": true,
      "is_user_node": true,
      "isegressgateway": true,
      "isingressgateway": true,
      "isinternetgateway": true,
      "isrelay": true,
      "isrelayed": true,
      "last_evaluated_at": "text",
      "lastcheckin": "text",
      "lastmodified": "text",
      "lastpeerupdate": "text",
      "localaddress": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "location": "text",
      "metadata": "text",
      "network": "text",
      "networkrange": 1,
      "networkrange6": 1,
      "node_status": "online",
      "ownerid": "text",
      "pendingdelete": true,
      "posture_check_violation_severity_level": 0,
      "posture_check_violations": [
        {
          "attribute": "text",
          "check_id": "text",
          "message": "text",
          "name": "text",
          "severity": 0
        }
      ],
      "relayedby": "text",
      "relaynodes": [
        "text"
      ],
      "server": "text",
      "static_node": {
        "address": "text",
        "address6": "text",
        "allowed_ips": [
          "text"
        ],
        "client_version": "text",
        "clientid": "text",
        "country": "text",
        "deniednodeacls": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "device_id": "text",
        "device_name": "text",
        "dns": "text",
        "enabled": true,
        "extraallowedips": [
          "text"
        ],
        "ingressgatewayendpoint": "text",
        "ingressgatewayid": "text",
        "jit_expires_at": "text",
        "kernel_version": "text",
        "last_evaluated_at": "text",
        "lastmodified": 1,
        "location": "text",
        "network": "text",
        "os": "text",
        "os_family": "text",
        "os_version": "text",
        "ownerid": "text",
        "postdown": "text",
        "postup": "text",
        "posture_check_violation_severity_level": 0,
        "posture_check_violations": [
          {
            "attribute": "text",
            "check_id": "text",
            "message": "text",
            "name": "text",
            "severity": 0
          }
        ],
        "privatekey": "text",
        "public_endpoint": "text",
        "publickey": "text",
        "remote_access_client_id": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  },
  "host": {
    "autoupdate": true,
    "country_code": "text",
    "daemoninstalled": true,
    "debug": true,
    "defaultinterface": "text",
    "dns_status": "text",
    "enable_flow_logs": true,
    "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,
    "kernel_version": "text",
    "listenport": 1,
    "location": "text",
    "macaddress": [
      1
    ],
    "mtu": 1,
    "name": "text",
    "nat_type": "text",
    "nodes": [
      "text"
    ],
    "os": "text",
    "os_family": "text",
    "os_version": "text",
    "persistentkeepalive": 1,
    "publickey": [
      1
    ],
    "traffickeypublic": [
      1
    ],
    "turn_endpoint": {},
    "verbosity": 1,
    "version": "text",
    "wg_public_listen_port": 1
  },
  "newMetrics": {
    "connectivity": {
      "ANY_ADDITIONAL_PROPERTY": {
        "actualuptime": 1,
        "connected": true,
        "lasttotalreceived": 1,
        "lasttotalsent": 1,
        "latency": 1,
        "node_name": "text",
        "percentup": 1,
        "totalreceived": 1,
        "totalsent": 1,
        "totaltime": 1,
        "uptime": 1
      }
    },
    "network": "text",
    "node_id": "text",
    "node_name": "text",
    "updated_at": "text"
  },
  "node": {
    "action": "text",
    "additional_rag_ips": [
      1
    ],
    "address": {
      "ip": [
        1
      ],
      "mask": [
        1
      ]
    },
    "address6": {
      "ip": [
        1
      ],
      "mask": [
        1
      ]
    },
    "auto_assign_gw": true,
    "auto_relayed_peers_v1": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "connected": true,
    "country_code": "text",
    "defaultacl": "text",
    "egressgatewaynatenabled": true,
    "egressgatewayranges": [
      "text"
    ],
    "egressgatewayrequest": {
      "natenabled": "text",
      "netid": "text",
      "nodeid": "text",
      "ranges": [
        "text"
      ],
      "ranges_with_metric": [
        {
          "nat": true,
          "nat_mode": "virtual_nat",
          "network": "text",
          "route_metric": 1,
          "virtual_network": "text"
        }
      ]
    },
    "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_auto_relay": true,
    "is_fail_over": true,
    "is_gw": true,
    "is_static": true,
    "is_user_node": true,
    "isegressgateway": true,
    "isingressgateway": true,
    "isinternetgateway": true,
    "isrelay": true,
    "isrelayed": true,
    "last_evaluated_at": "text",
    "lastcheckin": "text",
    "lastmodified": "text",
    "lastpeerupdate": "text",
    "localaddress": {
      "ip": [
        1
      ],
      "mask": [
        1
      ]
    },
    "location": "text",
    "metadata": "text",
    "network": "text",
    "networkrange": 1,
    "networkrange6": 1,
    "node_status": "online",
    "ownerid": "text",
    "pendingdelete": true,
    "posture_check_violation_severity_level": 0,
    "posture_check_violations": [
      {
        "attribute": "text",
        "check_id": "text",
        "message": "text",
        "name": "text",
        "severity": 0
      }
    ],
    "relayedby": "text",
    "relaynodes": [
      "text"
    ],
    "server": "text",
    "static_node": {
      "address": "text",
      "address6": "text",
      "allowed_ips": [
        "text"
      ],
      "client_version": "text",
      "clientid": "text",
      "country": "text",
      "deniednodeacls": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "device_id": "text",
      "device_name": "text",
      "dns": "text",
      "enabled": true,
      "extraallowedips": [
        "text"
      ],
      "ingressgatewayendpoint": "text",
      "ingressgatewayid": "text",
      "jit_expires_at": "text",
      "kernel_version": "text",
      "last_evaluated_at": "text",
      "lastmodified": 1,
      "location": "text",
      "network": "text",
      "os": "text",
      "os_family": "text",
      "os_version": "text",
      "ownerid": "text",
      "postdown": "text",
      "postup": "text",
      "posture_check_violation_severity_level": 0,
      "posture_check_violations": [
        {
          "attribute": "text",
          "check_id": "text",
          "message": "text",
          "name": "text",
          "severity": 0
        }
      ],
      "privatekey": "text",
      "public_endpoint": "text",
      "publickey": "text",
      "remote_access_client_id": "text",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "signal": {
    "action": "CONNECTION_NEGOTIATION",
    "auto_relay_node_metrics": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "from_host_id": "text",
    "from_host_pubkey": "text",
    "from_node_id": "text",
    "is_pro": true,
    "networkID": "text",
    "reply": true,
    "server": "text",
    "timestamp": 1,
    "to_host_id": "text",
    "to_host_pubkey": "text",
    "to_node_id": "text"
  }
}
text

Used by clients for "pull" command

get
Authorizations
Responses
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
GET /api/v1/host HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address_identity_map": {
    "ANY_ADDITIONAL_PROPERTY": {
      "id": "text",
      "name": "text",
      "type": 0
    }
  },
  "auto_relay_nodes": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "action": "text",
        "additional_rag_ips": [
          1
        ],
        "address": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "address6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "auto_assign_gw": true,
        "auto_relayed_peers_v1": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "connected": true,
        "country_code": "text",
        "defaultacl": "text",
        "egressgatewaynatenabled": true,
        "egressgatewayranges": [
          "text"
        ],
        "egressgatewayrequest": {
          "natenabled": "text",
          "netid": "text",
          "nodeid": "text",
          "ranges": [
            "text"
          ],
          "ranges_with_metric": [
            {
              "nat": true,
              "nat_mode": "virtual_nat",
              "network": "text",
              "route_metric": 1,
              "virtual_network": "text"
            }
          ]
        },
        "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_auto_relay": true,
        "is_fail_over": true,
        "is_gw": true,
        "is_static": true,
        "is_user_node": true,
        "isegressgateway": true,
        "isingressgateway": true,
        "isinternetgateway": true,
        "isrelay": true,
        "isrelayed": true,
        "last_evaluated_at": "text",
        "lastcheckin": "text",
        "lastmodified": "text",
        "lastpeerupdate": "text",
        "localaddress": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "location": "text",
        "metadata": "text",
        "network": "text",
        "networkrange": 1,
        "networkrange6": 1,
        "node_status": "online",
        "ownerid": "text",
        "pendingdelete": true,
        "posture_check_violation_severity_level": 0,
        "posture_check_violations": [
          {
            "attribute": "text",
            "check_id": "text",
            "message": "text",
            "name": "text",
            "severity": 0
          }
        ],
        "relayedby": "text",
        "relaynodes": [
          "text"
        ],
        "server": "text",
        "static_node": {
          "address": "text",
          "address6": "text",
          "allowed_ips": [
            "text"
          ],
          "client_version": "text",
          "clientid": "text",
          "country": "text",
          "deniednodeacls": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "device_id": "text",
          "device_name": "text",
          "dns": "text",
          "enabled": true,
          "extraallowedips": [
            "text"
          ],
          "ingressgatewayendpoint": "text",
          "ingressgatewayid": "text",
          "jit_expires_at": "text",
          "kernel_version": "text",
          "last_evaluated_at": "text",
          "lastmodified": 1,
          "location": "text",
          "network": "text",
          "os": "text",
          "os_family": "text",
          "os_version": "text",
          "ownerid": "text",
          "postdown": "text",
          "postup": "text",
          "posture_check_violation_severity_level": 0,
          "posture_check_violations": [
            {
              "attribute": "text",
              "check_id": "text",
              "message": "text",
              "name": "text",
              "severity": 0
            }
          ],
          "privatekey": "text",
          "public_endpoint": "text",
          "publickey": "text",
          "remote_access_client_id": "text",
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    ]
  },
  "change_default_gw": true,
  "default_gw_ip": [
    1
  ],
  "dns_nameservers": [
    {
      "ips": [
        "text"
      ],
      "is_fallback": true,
      "is_search_domain": true,
      "match_domain": "text"
    }
  ],
  "egress_network_routes": [
    {
      "egress_gw_addr": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "egress_gw_addr6": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "egress_ranges": [
        "text"
      ],
      "egress_ranges_metric": [
        {
          "nat": true,
          "nat_mode": "virtual_nat",
          "network": "text",
          "route_metric": 1,
          "virtual_network": "text"
        }
      ],
      "network": "text",
      "node_addr": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "node_addr6": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "peer_key": "text"
    }
  ],
  "egress_with_domains": [
    {
      "domain": "text",
      "host": {
        "autoupdate": true,
        "country_code": "text",
        "daemoninstalled": true,
        "debug": true,
        "defaultinterface": "text",
        "dns_status": "text",
        "enable_flow_logs": true,
        "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,
        "kernel_version": "text",
        "listenport": 1,
        "location": "text",
        "macaddress": [
          1
        ],
        "mtu": 1,
        "name": "text",
        "nat_type": "text",
        "nodes": [
          "text"
        ],
        "os": "text",
        "os_family": "text",
        "os_version": "text",
        "persistentkeepalive": 1,
        "publickey": [
          1
        ],
        "traffickeypublic": [
          1
        ],
        "turn_endpoint": {},
        "verbosity": 1,
        "version": "text",
        "wg_public_listen_port": 1
      },
      "id": "text",
      "node": {
        "action": "text",
        "additional_rag_ips": [
          1
        ],
        "address": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "address6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "auto_assign_gw": true,
        "auto_relayed_peers_v1": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "connected": true,
        "country_code": "text",
        "defaultacl": "text",
        "egressgatewaynatenabled": true,
        "egressgatewayranges": [
          "text"
        ],
        "egressgatewayrequest": {
          "natenabled": "text",
          "netid": "text",
          "nodeid": "text",
          "ranges": [
            "text"
          ],
          "ranges_with_metric": [
            {
              "nat": true,
              "nat_mode": "virtual_nat",
              "network": "text",
              "route_metric": 1,
              "virtual_network": "text"
            }
          ]
        },
        "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_auto_relay": true,
        "is_fail_over": true,
        "is_gw": true,
        "is_static": true,
        "is_user_node": true,
        "isegressgateway": true,
        "isingressgateway": true,
        "isinternetgateway": true,
        "isrelay": true,
        "isrelayed": true,
        "last_evaluated_at": "text",
        "lastcheckin": "text",
        "lastmodified": "text",
        "lastpeerupdate": "text",
        "localaddress": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "location": "text",
        "metadata": "text",
        "network": "text",
        "networkrange": 1,
        "networkrange6": 1,
        "node_status": "online",
        "ownerid": "text",
        "pendingdelete": true,
        "posture_check_violation_severity_level": 0,
        "posture_check_violations": [
          {
            "attribute": "text",
            "check_id": "text",
            "message": "text",
            "name": "text",
            "severity": 0
          }
        ],
        "relayedby": "text",
        "relaynodes": [
          "text"
        ],
        "server": "text",
        "static_node": {
          "address": "text",
          "address6": "text",
          "allowed_ips": [
            "text"
          ],
          "client_version": "text",
          "clientid": "text",
          "country": "text",
          "deniednodeacls": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "device_id": "text",
          "device_name": "text",
          "dns": "text",
          "enabled": true,
          "extraallowedips": [
            "text"
          ],
          "ingressgatewayendpoint": "text",
          "ingressgatewayid": "text",
          "jit_expires_at": "text",
          "kernel_version": "text",
          "last_evaluated_at": "text",
          "lastmodified": 1,
          "location": "text",
          "network": "text",
          "os": "text",
          "os_family": "text",
          "os_version": "text",
          "ownerid": "text",
          "postdown": "text",
          "postup": "text",
          "posture_check_violation_severity_level": 0,
          "posture_check_violations": [
            {
              "attribute": "text",
              "check_id": "text",
              "message": "text",
              "name": "text",
              "severity": 0
            }
          ],
          "privatekey": "text",
          "public_endpoint": "text",
          "publickey": "text",
          "remote_access_client_id": "text",
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    }
  ],
  "endpoint_detection": true,
  "fw_update": {
    "acl_rules": {
      "ANY_ADDITIONAL_PROPERTY": {
        "allowed": true,
        "allowed_ports": [
          "text"
        ],
        "allowed_protocols": "all",
        "direction": 0,
        "dst": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "dst6": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "id": "text",
        "ip_list": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "ip6_list": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ]
      }
    },
    "allow_all": true,
    "egress_info": {
      "ANY_ADDITIONAL_PROPERTY": {
        "egress_fw_rules": {
          "ANY_ADDITIONAL_PROPERTY": {
            "allowed": true,
            "allowed_ports": [
              "text"
            ],
            "allowed_protocols": "all",
            "direction": 0,
            "dst": [
              {
                "ip": [
                  1
                ],
                "mask": [
                  1
                ]
              }
            ],
            "dst6": [
              {
                "ip": [
                  1
                ],
                "mask": [
                  1
                ]
              }
            ],
            "id": "text",
            "ip_list": [
              {
                "ip": [
                  1
                ],
                "mask": [
                  1
                ]
              }
            ],
            "ip6_list": [
              {
                "ip": [
                  1
                ],
                "mask": [
                  1
                ]
              }
            ]
          }
        },
        "egress_gateway_cfg": {
          "natenabled": "text",
          "netid": "text",
          "nodeid": "text",
          "ranges": [
            "text"
          ],
          "ranges_with_metric": [
            {
              "nat": true,
              "nat_mode": "virtual_nat",
              "network": "text",
              "route_metric": 1,
              "virtual_network": "text"
            }
          ]
        },
        "egress_gw_addr": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "egress_gw_addr6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "egress_id": "text",
        "network": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "network6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        }
      }
    },
    "ingress_info": {
      "ANY_ADDITIONAL_PROPERTY": {
        "egress_ranges": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "egress_ranges6": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "ingress_id": "text",
        "network": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "network6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "rules": [
          {
            "allow": true,
            "allowed_ports": [
              "text"
            ],
            "allowed_protocols": "all",
            "dst_ip": {
              "ip": [
                1
              ],
              "mask": [
                1
              ]
            },
            "src_ip": {
              "ip": [
                1
              ],
              "mask": [
                1
              ]
            }
          }
        ],
        "static_node_ips": [
          [
            1
          ]
        ]
      }
    },
    "is_egress_gw": true,
    "is_ingress_gw": true,
    "networks": [
      {
        "allowed": true,
        "allowed_ports": [
          "text"
        ],
        "allowed_protocols": "all",
        "direction": 0,
        "dst": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "dst6": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "id": "text",
        "ip_list": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ],
        "ip6_list": [
          {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          }
        ]
      }
    ]
  },
  "gw_nodes": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "action": "text",
        "additional_rag_ips": [
          1
        ],
        "address": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "address6": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "auto_assign_gw": true,
        "auto_relayed_peers_v1": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "connected": true,
        "country_code": "text",
        "defaultacl": "text",
        "egressgatewaynatenabled": true,
        "egressgatewayranges": [
          "text"
        ],
        "egressgatewayrequest": {
          "natenabled": "text",
          "netid": "text",
          "nodeid": "text",
          "ranges": [
            "text"
          ],
          "ranges_with_metric": [
            {
              "nat": true,
              "nat_mode": "virtual_nat",
              "network": "text",
              "route_metric": 1,
              "virtual_network": "text"
            }
          ]
        },
        "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_auto_relay": true,
        "is_fail_over": true,
        "is_gw": true,
        "is_static": true,
        "is_user_node": true,
        "isegressgateway": true,
        "isingressgateway": true,
        "isinternetgateway": true,
        "isrelay": true,
        "isrelayed": true,
        "last_evaluated_at": "text",
        "lastcheckin": "text",
        "lastmodified": "text",
        "lastpeerupdate": "text",
        "localaddress": {
          "ip": [
            1
          ],
          "mask": [
            1
          ]
        },
        "location": "text",
        "metadata": "text",
        "network": "text",
        "networkrange": 1,
        "networkrange6": 1,
        "node_status": "online",
        "ownerid": "text",
        "pendingdelete": true,
        "posture_check_violation_severity_level": 0,
        "posture_check_violations": [
          {
            "attribute": "text",
            "check_id": "text",
            "message": "text",
            "name": "text",
            "severity": 0
          }
        ],
        "relayedby": "text",
        "relaynodes": [
          "text"
        ],
        "server": "text",
        "static_node": {
          "address": "text",
          "address6": "text",
          "allowed_ips": [
            "text"
          ],
          "client_version": "text",
          "clientid": "text",
          "country": "text",
          "deniednodeacls": {
            "ANY_ADDITIONAL_PROPERTY": {}
          },
          "device_id": "text",
          "device_name": "text",
          "dns": "text",
          "enabled": true,
          "extraallowedips": [
            "text"
          ],
          "ingressgatewayendpoint": "text",
          "ingressgatewayid": "text",
          "jit_expires_at": "text",
          "kernel_version": "text",
          "last_evaluated_at": "text",
          "lastmodified": 1,
          "location": "text",
          "network": "text",
          "os": "text",
          "os_family": "text",
          "os_version": "text",
          "ownerid": "text",
          "postdown": "text",
          "postup": "text",
          "posture_check_violation_severity_level": 0,
          "posture_check_violations": [
            {
              "attribute": "text",
              "check_id": "text",
              "message": "text",
              "name": "text",
              "severity": 0
            }
          ],
          "privatekey": "text",
          "public_endpoint": "text",
          "publickey": "text",
          "remote_access_client_id": "text",
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        },
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    ]
  },
  "host": {
    "autoupdate": true,
    "country_code": "text",
    "daemoninstalled": true,
    "debug": true,
    "defaultinterface": "text",
    "dns_status": "text",
    "enable_flow_logs": true,
    "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,
    "kernel_version": "text",
    "listenport": 1,
    "location": "text",
    "macaddress": [
      1
    ],
    "mtu": 1,
    "name": "text",
    "nat_type": "text",
    "nodes": [
      "text"
    ],
    "os": "text",
    "os_family": "text",
    "os_version": "text",
    "persistentkeepalive": 1,
    "publickey": [
      1
    ],
    "traffickeypublic": [
      1
    ],
    "turn_endpoint": {},
    "verbosity": 1,
    "version": "text",
    "wg_public_listen_port": 1
  },
  "host_network_info": {
    "ANY_ADDITIONAL_PROPERTY": {
      "interfaces": [
        {
          "address": {
            "ip": [
              1
            ],
            "mask": [
              1
            ]
          },
          "addressString": "text",
          "name": "text"
        }
      ],
      "is_static": true,
      "is_static_port": true,
      "listen_port": 1,
      "version": "text"
    }
  },
  "is_inet_gw": true,
  "name_servers": [
    "text"
  ],
  "nodes": [
    {
      "action": "text",
      "additional_rag_ips": [
        1
      ],
      "address": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "address6": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "auto_assign_gw": true,
      "auto_relayed_peers_v1": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "connected": true,
      "country_code": "text",
      "defaultacl": "text",
      "egressgatewaynatenabled": true,
      "egressgatewayranges": [
        "text"
      ],
      "egressgatewayrequest": {
        "natenabled": "text",
        "netid": "text",
        "nodeid": "text",
        "ranges": [
          "text"
        ],
        "ranges_with_metric": [
          {
            "nat": true,
            "nat_mode": "virtual_nat",
            "network": "text",
            "route_metric": 1,
            "virtual_network": "text"
          }
        ]
      },
      "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_auto_relay": true,
      "is_fail_over": true,
      "is_gw": true,
      "is_static": true,
      "is_user_node": true,
      "isegressgateway": true,
      "isingressgateway": true,
      "isinternetgateway": true,
      "isrelay": true,
      "isrelayed": true,
      "last_evaluated_at": "text",
      "lastcheckin": "text",
      "lastmodified": "text",
      "lastpeerupdate": "text",
      "localaddress": {
        "ip": [
          1
        ],
        "mask": [
          1
        ]
      },
      "location": "text",
      "metadata": "text",
      "network": "text",
      "networkrange": 1,
      "networkrange6": 1,
      "node_status": "online",
      "ownerid": "text",
      "pendingdelete": true,
      "posture_check_violation_severity_level": 0,
      "posture_check_violations": [
        {
          "attribute": "text",
          "check_id": "text",
          "message": "text",
          "name": "text",
          "severity": 0
        }
      ],
      "relayedby": "text",
      "relaynodes": [
        "text"
      ],
      "server": "text",
      "static_node": {
        "address": "text",
        "address6": "text",
        "allowed_ips": [
          "text"
        ],
        "client_version": "text",
        "clientid": "text",
        "country": "text",
        "deniednodeacls": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "device_id": "text",
        "device_name": "text",
        "dns": "text",
        "enabled": true,
        "extraallowedips": [
          "text"
        ],
        "ingressgatewayendpoint": "text",
        "ingressgatewayid": "text",
        "jit_expires_at": "text",
        "kernel_version": "text",
        "last_evaluated_at": "text",
        "lastmodified": 1,
        "location": "text",
        "network": "text",
        "os": "text",
        "os_family": "text",
        "os_version": "text",
        "ownerid": "text",
        "postdown": "text",
        "postup": "text",
        "posture_check_violation_severity_level": 0,
        "posture_check_violations": [
          {
            "attribute": "text",
            "check_id": "text",
            "message": "text",
            "name": "text",
            "severity": 0
          }
        ],
        "privatekey": "text",
        "public_endpoint": "text",
        "publickey": "text",
        "remote_access_client_id": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "peer_ids": {
    "ANY_ADDITIONAL_PROPERTY": {
      "address": "text",
      "address4": "text",
      "address6": "text",
      "host_id": "text",
      "id": "text",
      "is_extclient": true,
      "isserver": "text",
      "listen_port": 1,
      "name": "text",
      "network": "text",
      "username": "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
    }
  ],
  "replace_peers": true,
  "server_config": {
    "Is_EE": true,
    "api": "text",
    "apihost": "text",
    "apiport": "text",
    "broker": "text",
    "brokerType": "text",
    "coreDNSAddr": "text",
    "defaultDomain": "text",
    "dnsmode": "text",
    "endpointDetection": true,
    "grpc": "text",
    "ipdetectionInterval": 1,
    "manageDNS": true,
    "metricInterval": "text",
    "metricsPort": 1,
    "mqpassword": "text",
    "mqport": "text",
    "mquserName": "text",
    "peerConnectionCheckInterval": "text",
    "server": "text",
    "stun": true,
    "stunServers": "text",
    "trafficKey": [
      1
    ],
    "version": "text"
  }
}

Fetches host peerinfo

get
Authorizations
Path parameters
hostidstringRequired

Host ID

Responses
200

OK

application/json
get/api/v1/host/{hostid}/peer_info
GET /api/v1/host/{hostid}/peer_info HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "network_peers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "address": "text",
        "address4": "text",
        "address6": "text",
        "host_id": "text",
        "id": "text",
        "is_extclient": true,
        "isserver": "text",
        "listen_port": 1,
        "name": "text",
        "network": "text",
        "username": "text"
      }
    }
  }
}

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
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
POST /api/v1/host/{hostid}/signalpeer HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "action": "CONNECTION_NEGOTIATION",
  "auto_relay_node_metrics": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "from_host_id": "text",
  "from_host_pubkey": "text",
  "from_node_id": "text",
  "is_pro": true,
  "networkID": "text",
  "reply": true,
  "server": "text",
  "timestamp": 1,
  "to_host_id": "text",
  "to_host_pubkey": "text",
  "to_node_id": "text"
}
{
  "action": "CONNECTION_NEGOTIATION",
  "auto_relay_node_metrics": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "from_host_id": "text",
  "from_host_pubkey": "text",
  "from_node_id": "text",
  "is_pro": true,
  "networkID": "text",
  "reply": true,
  "server": "text",
  "timestamp": 1,
  "to_host_id": "text",
  "to_host_pubkey": "text",
  "to_node_id": "text"
}

List pending hosts in a network

get
Authorizations
Query parameters
networkstringRequired

Network ID

Responses
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
GET /api/v1/pending_hosts?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "enrollment_key_id": [
      1
    ],
    "host_id": "text",
    "host_name": "text",
    "id": "text",
    "location": "text",
    "network": "text",
    "os": "text",
    "public_key": "text",
    "requested_at": "text",
    "version": "text"
  }
]

Approve pending host in a network

post
Authorizations
Path parameters
idstringRequired

Pending Host ID

Responses
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}
POST /api/v1/pending_hosts/approve/{id} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "additional_rag_ips": [
    "text"
  ],
  "address": "text",
  "address6": "text",
  "allowedips": [
    "text"
  ],
  "auto_assign_gw": true,
  "auto_relayed_peers": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "connected": true,
  "country": "text",
  "defaultacl": "text",
  "dnson": true,
  "egressgatewaynatenabled": true,
  "egressgatewayranges": [
    "text"
  ],
  "egressgatewayranges_with_metric": [
    {
      "nat": true,
      "nat_mode": "virtual_nat",
      "network": "text",
      "route_metric": 1,
      "virtual_network": "text"
    }
  ],
  "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_auto_relay": true,
  "is_fail_over": true,
  "is_gw": true,
  "is_static": true,
  "is_user_node": true,
  "isegressgateway": true,
  "isingressgateway": true,
  "isinternetgateway": true,
  "isrelay": true,
  "isrelayed": true,
  "last_evaluated_at": "text",
  "lastcheckin": 1,
  "lastmodified": 1,
  "lastpeerupdate": 1,
  "localaddress": "text",
  "location": "text",
  "metadata": "text",
  "network": "text",
  "networkrange": "text",
  "networkrange6": "text",
  "pendingdelete": true,
  "posture_check_violation_severity_level": 0,
  "posture_check_violations": [
    {
      "attribute": "text",
      "check_id": "text",
      "message": "text",
      "name": "text",
      "severity": 0
    }
  ],
  "relayedby": "text",
  "relaynodes": [
    "text"
  ],
  "server": "text",
  "static_node": {
    "address": "text",
    "address6": "text",
    "allowed_ips": [
      "text"
    ],
    "client_version": "text",
    "clientid": "text",
    "country": "text",
    "deniednodeacls": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "device_id": "text",
    "device_name": "text",
    "dns": "text",
    "enabled": true,
    "extraallowedips": [
      "text"
    ],
    "ingressgatewayendpoint": "text",
    "ingressgatewayid": "text",
    "jit_expires_at": "text",
    "kernel_version": "text",
    "last_evaluated_at": "text",
    "lastmodified": 1,
    "location": "text",
    "network": "text",
    "os": "text",
    "os_family": "text",
    "os_version": "text",
    "ownerid": "text",
    "postdown": "text",
    "postup": "text",
    "posture_check_violation_severity_level": 0,
    "posture_check_violations": [
      {
        "attribute": "text",
        "check_id": "text",
        "message": "text",
        "name": "text",
        "severity": 0
      }
    ],
    "privatekey": "text",
    "public_endpoint": "text",
    "publickey": "text",
    "remote_access_client_id": "text",
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "status": "online",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Reject pending host in a network

post
Authorizations
Path parameters
idstringRequired

Pending Host ID

Responses
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}
POST /api/v1/pending_hosts/reject/{id} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "enrollment_key_id": [
    1
  ],
  "host_id": "text",
  "host_name": "text",
  "id": "text",
  "location": "text",
  "network": "text",
  "os": "text",
  "public_key": "text",
  "requested_at": "text",
  "version": "text"
}
PreviousIP Service
NextAuth

Last updated

Was this helpful?