Remote Access Client

Fetches All Remote Access Clients across all networks

get

Authorizations

oauth2

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/extclients

HTTPcURLJavaScriptPython

GET /api/extclients HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address": "text",
  "address6": "text",
  "allowed_ips": [
    "text"
  ],
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "ingressgatewayendpoint": "text",
  "ingressgatewayid": "text",
  "lastmodified": 1,
  "network": "text",
  "os": "text",
  "ownerid": "text",
  "postdown": "text",
  "postup": "text",
  "privatekey": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Get all remote access client associated with network

get

Authorizations

oauth2

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/extclients/{network}

HTTPcURLJavaScriptPython

GET /api/extclients/{network} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address": "text",
  "address6": "text",
  "allowed_ips": [
    "text"
  ],
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "ingressgatewayendpoint": "text",
  "ingressgatewayid": "text",
  "lastmodified": 1,
  "network": "text",
  "os": "text",
  "ownerid": "text",
  "postdown": "text",
  "postup": "text",
  "privatekey": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Get an individual remote access client

get

Authorizations

oauth2

Responses

200

OK

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/extclients/{network}/{clientid}

HTTPcURLJavaScriptPython

GET /api/extclients/{network}/{clientid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address": "text",
  "address6": "text",
  "allowed_ips": [
    "text"
  ],
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "ingressgatewayendpoint": "text",
  "ingressgatewayid": "text",
  "lastmodified": 1,
  "network": "text",
  "os": "text",
  "ownerid": "text",
  "postdown": "text",
  "postup": "text",
  "privatekey": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Update an individual remote access client

put

Authorizations

oauth2

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

put

/api/extclients/{network}/{clientid}

HTTPcURLJavaScriptPython

PUT /api/extclients/{network}/{clientid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address": "text",
  "address6": "text",
  "allowed_ips": [
    "text"
  ],
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "ingressgatewayendpoint": "text",
  "ingressgatewayid": "text",
  "lastmodified": 1,
  "network": "text",
  "os": "text",
  "ownerid": "text",
  "postdown": "text",
  "postup": "text",
  "privatekey": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Delete an individual remote access client

delete

Authorizations

oauth2

Responses

200

OK

No content

403

Forbidden

application/json

500

Internal Server Error

application/json

delete

/api/extclients/{network}/{clientid}

HTTPcURLJavaScriptPython

DELETE /api/extclients/{network}/{clientid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

No content

Get an individual remote access client

get

Authorizations

oauth2

Responses

200

OK

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/extclients/{network}/{clientid}/{type}

HTTPcURLJavaScriptPython

GET /api/extclients/{network}/{clientid}/{type} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "address": "text",
  "address6": "text",
  "allowed_ips": [
    "text"
  ],
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "ingressgatewayendpoint": "text",
  "ingressgatewayid": "text",
  "lastmodified": 1,
  "network": "text",
  "os": "text",
  "ownerid": "text",
  "postdown": "text",
  "postup": "text",
  "privatekey": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Create an individual remote access client

post

Authorizations

oauth2

Responses

200

OK

application/json

Responsestring

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/extclients/{network}/{nodeid}

HTTPcURLJavaScriptPython

POST /api/extclients/{network}/{nodeid} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text