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

Auto Relay

Reset AutoRelay for a network

post
Authorizations
Path parameters
networkstringRequired

Network ID

Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
post/api/v1/node/{network}/auto_relay/reset
POST /api/v1/node/{network}/auto_relay/reset HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}

Get auto relay nodes

get
Authorizations
Path parameters
nodeidstringRequired

Node ID

Responses
200

OK

application/json
actionstringOptional
additional_rag_ipsnumber[]Optional
auto_assign_gwbooleanOptional
connectedbooleanOptional
country_codestringOptional
defaultaclstringOptional

== PRO ==

egressgatewaynatenabledbooleanOptional
egressgatewayrangesstring[]Optional
expdatetimestringOptional
failed_over_bystringOptional
hostidstringOptional
idstringOptional
ingressdnsstringOptional
ingressgatewayrangestringOptional
ingressgatewayrange6stringOptional
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
lastcheckinstringOptional
lastmodifiedstringOptional
lastpeerupdatestringOptional
locationstringOptional

Format: "lat,lon"

metadatastringOptional
networkstringOptional
networkrangeintegerOptional
networkrange6numberOptional
node_statusstring · enumOptionalPossible values:
owneridstringOptional
pendingdeletebooleanOptional
posture_check_violation_severity_levelinteger · enumOptionalPossible values:
relayedbystringOptional
relaynodesstring[]Optional
serverstringOptional
get/api/v1/node/{nodeid}/auto_relay
GET /api/v1/node/{nodeid}/auto_relay 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
      ]
    },
    "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": {}
    }
  }
]

Create AutoRelay node

post
Authorizations
Path parameters
nodeidstringRequired

Node ID

Responses
200

OK

application/json
actionstringOptional
additional_rag_ipsnumber[]Optional
auto_assign_gwbooleanOptional
connectedbooleanOptional
country_codestringOptional
defaultaclstringOptional

== PRO ==

egressgatewaynatenabledbooleanOptional
egressgatewayrangesstring[]Optional
expdatetimestringOptional
failed_over_bystringOptional
hostidstringOptional
idstringOptional
ingressdnsstringOptional
ingressgatewayrangestringOptional
ingressgatewayrange6stringOptional
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
lastcheckinstringOptional
lastmodifiedstringOptional
lastpeerupdatestringOptional
locationstringOptional

Format: "lat,lon"

metadatastringOptional
networkstringOptional
networkrangeintegerOptional
networkrange6numberOptional
node_statusstring · enumOptionalPossible values:
owneridstringOptional
pendingdeletebooleanOptional
posture_check_violation_severity_levelinteger · enumOptionalPossible values:
relayedbystringOptional
relaynodesstring[]Optional
serverstringOptional
post/api/v1/node/{nodeid}/auto_relay
POST /api/v1/node/{nodeid}/auto_relay 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
    ]
  },
  "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": {}
  }
}

Delete autorelay node

delete
Authorizations
Path parameters
nodeidstringRequired

Node ID

Responses
200

OK

application/json
actionstringOptional
additional_rag_ipsnumber[]Optional
auto_assign_gwbooleanOptional
connectedbooleanOptional
country_codestringOptional
defaultaclstringOptional

== PRO ==

egressgatewaynatenabledbooleanOptional
egressgatewayrangesstring[]Optional
expdatetimestringOptional
failed_over_bystringOptional
hostidstringOptional
idstringOptional
ingressdnsstringOptional
ingressgatewayrangestringOptional
ingressgatewayrange6stringOptional
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
lastcheckinstringOptional
lastmodifiedstringOptional
lastpeerupdatestringOptional
locationstringOptional

Format: "lat,lon"

metadatastringOptional
networkstringOptional
networkrangeintegerOptional
networkrange6numberOptional
node_statusstring · enumOptionalPossible values:
owneridstringOptional
pendingdeletebooleanOptional
posture_check_violation_severity_levelinteger · enumOptionalPossible values:
relayedbystringOptional
relaynodesstring[]Optional
serverstringOptional
delete/api/v1/node/{nodeid}/auto_relay
DELETE /api/v1/node/{nodeid}/auto_relay 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
    ]
  },
  "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": {}
  }
}

Check AutoRelay context

get
Authorizations
Path parameters
nodeidstringRequired

Node ID

Body
auto_relay_gw_idstringOptional
node_idstringOptional
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
get/api/v1/node/{nodeid}/auto_relay_check
GET /api/v1/node/{nodeid}/auto_relay_check HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "auto_relay_gw_id": "text",
  "node_id": "text"
}
{
  "code": 1,
  "message": "text",
  "response": null
}

AutoRelay me

post
Authorizations
Path parameters
nodeidstringRequired

Node ID

Body
auto_relay_gw_idstringOptional
node_idstringOptional
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
post/api/v1/node/{nodeid}/auto_relay_me
POST /api/v1/node/{nodeid}/auto_relay_me HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "auto_relay_gw_id": "text",
  "node_id": "text"
}
{
  "code": 1,
  "message": "text",
  "response": null
}

Update AutoRelay me

put
Authorizations
Path parameters
nodeidstringRequired

Node ID

Body
auto_relay_gw_idstringOptional
node_idstringOptional
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
put/api/v1/node/{nodeid}/auto_relay_me
PUT /api/v1/node/{nodeid}/auto_relay_me HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "auto_relay_gw_id": "text",
  "node_id": "text"
}
{
  "code": 1,
  "message": "text",
  "response": null
}
PreviousJIT
NextPosture Check

Last updated

Was this helpful?