Networks

Lists all networks

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/networks

HTTPcURLJavaScriptPython

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

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

Create a network

post

Authorizations

oauth

Body

application/json

addressrangestringOptional

addressrange6stringOptional

allowmanualsignupstringOptional

defaultaclstringOptional

defaultinterfacestring · min: 1 · max: 35Optional

defaultkeepaliveinteger · max: 1000Optional

defaultlistenportinteger · min: 1024 · max: 65535Optional

defaultmtuintegerOptional

defaultpostdownstringOptional

defaultudpholepunchstringOptional

dns_nameserversstring[]Optional

isipv4stringOptional

isipv6stringOptional

netidstring · min: 1 · max: 32Required

networklastmodifiedinteger · int64Optional

nodelimitintegerOptional

nodeslastmodifiedinteger · int64Optional

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/networks

HTTPcURLJavaScriptPython

POST /api/networks HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

Get a network

get

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/networks/{networkname}

HTTPcURLJavaScriptPython

GET /api/networks/{networkname} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

Update network settings

put

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Body

application/json

addressrangestringOptional

addressrange6stringOptional

allowmanualsignupstringOptional

defaultaclstringOptional

defaultinterfacestring · min: 1 · max: 35Optional

defaultkeepaliveinteger · max: 1000Optional

defaultlistenportinteger · min: 1024 · max: 65535Optional

defaultmtuintegerOptional

defaultpostdownstringOptional

defaultudpholepunchstringOptional

dns_nameserversstring[]Optional

isipv4stringOptional

isipv6stringOptional

netidstring · min: 1 · max: 32Required

networklastmodifiedinteger · int64Optional

nodelimitintegerOptional

nodeslastmodifiedinteger · int64Optional

Responses

200

OK

application/json

400

Bad Request

application/json

put

/api/networks/{networkname}

HTTPcURLJavaScriptPython

PUT /api/networks/{networkname} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

{
  "addressrange": "text",
  "addressrange6": "text",
  "allowmanualsignup": "text",
  "defaultacl": "text",
  "defaultinterface": "text",
  "defaultkeepalive": 1,
  "defaultlistenport": 1,
  "defaultmtu": 1,
  "defaultpostdown": "text",
  "defaultudpholepunch": "text",
  "dns_nameservers": [
    "text"
  ],
  "isipv4": "text",
  "isipv6": "text",
  "netid": "text",
  "networklastmodified": 1,
  "nodelimit": 1,
  "nodeslastmodified": 1
}

Delete a network

delete

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Query parameters

forcebooleanOptional

Force Delete

Responses

200

OK

application/json

400

Bad Request

application/json

403

Forbidden

application/json

delete

/api/networks/{networkname}

HTTPcURLJavaScriptPython

DELETE /api/networks/{networkname} HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

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

Get a network ACL (Access Control List)

get

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/networks/{networkname}/acls

HTTPcURLJavaScriptPython

GET /api/networks/{networkname}/acls HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Update a network ACL (Access Control List)

put

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/networks/{networkname}/acls

HTTPcURLJavaScriptPython

PUT /api/networks/{networkname}/acls HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Update a network ACL (Access Control List)

put

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

put

/api/networks/{networkname}/acls/v2

HTTPcURLJavaScriptPython

PUT /api/networks/{networkname}/acls/v2 HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Get a network Egress routes

get

Authorizations

oauth

Path parameters

networknamestringRequired

Network name

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/networks/{networkname}/egress_routes

HTTPcURLJavaScriptPython

GET /api/networks/{networkname}/egress_routes HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

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

Lists all networks with stats

get

Authorizations

oauth

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/v1/networks/stats

HTTPcURLJavaScriptPython

GET /api/v1/networks/stats HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

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