Gateways

Create a gateway

post

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Node ID

Body

application/json

extclientdnsstringOptional

inet_node_client_idsstring[]Optional

is_internet_gwbooleanOptional

metadatastringOptional

mtuintegerOptional

netidstringOptional

nodeidstringOptional

persistentkeepaliveintegerOptional

relayaddrsstring[]Optional

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:

500

Internal Server Error

application/json

post

/api/nodes/{network}/{nodeid}/gateway

HTTPcURLJavaScriptPython

POST /api/nodes/{network}/{nodeid}/gateway HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "extclientdns": "text",
  "inet_node_client_ids": [
    "text"
  ],
  "is_internet_gw": true,
  "metadata": "text",
  "mtu": 1,
  "netid": "text",
  "nodeid": "text",
  "persistentkeepalive": 1,
  "relayaddrs": [
    "text"
  ]
}

{
  "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": {}
  }
}

Delete a gateway

delete

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Node 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:

500

Internal Server Error

application/json

delete

/api/nodes/{network}/{nodeid}/gateway

HTTPcURLJavaScriptPython

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"
  ],
  "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": {}
  }
}

Assign a node to a gateway

post

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Client node ID to assign to gateway

Query parameters

gw_idstringRequired

Gateway node ID

auto_assign_gwbooleanOptional

Enable auto-assign gateway (Pro only)

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:

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/nodes/{network}/{nodeid}/gateway/assign

HTTPcURLJavaScriptPython

POST /api/nodes/{network}/{nodeid}/gateway/assign?gw_id=text 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": {}
  }
}

Unassign client nodes from a gateway

post

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Node 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:

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/nodes/{network}/{nodeid}/gateway/unassign

HTTPcURLJavaScriptPython

POST /api/nodes/{network}/{nodeid}/gateway/unassign 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": {}
  }
}