Config Files

Fetch all config files across all networks

get

Authorizations

oauth

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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

Get all config files associated with network

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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

Get an individual config file

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

clientidstringRequired

Client ID

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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

Update a config file

put

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

clientidstringRequired

Client ID

Body

application/json

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

is_already_connected_to_inet_gwbooleanOptional

kernel_versionstringOptional

locationstringOptional

format: lat,long

osstringOptional

os_familystringOptional

os_versionstringOptional

postdownstring · max: 1024Optional

postupstring · max: 1024Optional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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
Content-Type: application/json
Accept: */*
Content-Length: 484

{
  "client_version": "text",
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_id": "text",
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "is_already_connected_to_inet_gw": true,
  "kernel_version": "text",
  "location": "text",
  "os": "text",
  "os_family": "text",
  "os_version": "text",
  "postdown": "text",
  "postup": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

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

Delete a config file

delete

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

clientidstringRequired

Client ID

Responses

200

OK

application/json

codeintegerOptional

messagestringOptional

responseanyOptional

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: */*

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

Get config file configuration

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

clientidstringRequired

Client ID

typestringRequired

Config type (qr or file)

Query parameters

preferredipstringOptional

Preferred endpoint IP

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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

Create a config file

post

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

nodeidstringRequired

Node ID (Ingress Gateway)

Body

application/json

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

is_already_connected_to_inet_gwbooleanOptional

kernel_versionstringOptional

locationstringOptional

format: lat,long

osstringOptional

os_familystringOptional

os_versionstringOptional

postdownstring · max: 1024Optional

postupstring · max: 1024Optional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

allowed_ipsstring[]Optional

client_versionstringOptional

clientidstringOptional

countrystringOptional

device_idstringOptional

device_namestringOptional

dnsstringOptional

enabledbooleanOptional

extraallowedipsstring[]Optional

ingressgatewayendpointstringOptional

ingressgatewayidstringOptional

jit_expires_atstringOptional

JIT grant expiry time (nil if JIT not enabled or user is admin)

kernel_versionstringOptional

last_evaluated_atstringOptional

lastmodifiedinteger · int64Optional

locationstringOptional

format: lat,long

networkstringOptional

osstringOptional

os_familystringOptional

os_versionstringOptional

owneridstringOptional

postdownstringOptional

postupstringOptional

posture_check_violation_severity_levelinteger · enumOptionalPossible values:

privatekeystringOptional

public_endpointstringOptional

publickeystringOptional

remote_access_client_idstringOptional

unique ID (MAC address) of RAC machine

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
Content-Type: application/json
Accept: */*
Content-Length: 484

{
  "client_version": "text",
  "clientid": "text",
  "country": "text",
  "deniednodeacls": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "device_id": "text",
  "device_name": "text",
  "dns": "text",
  "enabled": true,
  "extraallowedips": [
    "text"
  ],
  "is_already_connected_to_inet_gw": true,
  "kernel_version": "text",
  "location": "text",
  "os": "text",
  "os_family": "text",
  "os_version": "text",
  "postdown": "text",
  "postup": "text",
  "public_endpoint": "text",
  "publickey": "text",
  "remote_access_client_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

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

Get config file HA configuration

get

Authorizations

oauth

Path parameters

networkstringRequired

Network ID

Responses

200

WireGuard config file

application/json

stringOptional

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/v1/client_conf/{network}

HTTPcURLJavaScriptPython

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

text