DNS

Get all DNS entries

get

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/dns

HTTPcURLJavaScriptPython

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

[
  {
    "address": "text",
    "address6": "text",
    "name": "text",
    "network": "text"
  }
]

Gets node DNS entries associated with a network

get

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/dns/{network}

HTTPcURLJavaScriptPython

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

[
  {
    "address": "text",
    "address6": "text",
    "name": "text",
    "network": "text"
  }
]

Delete a DNS entry

delete

Path parameters

networkstringRequired

Network identifier

domainstringRequired

Domain Name

Responses

200

OK

application/json

500

Internal Server Error

application/json

delete

/api/dns/{network}/{domain}

HTTPcURLJavaScriptPython

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

[
  {
    "address": "text",
    "address6": "text",
    "name": "text",
    "network": "text"
  }
]

Get all DNS entries associated with the network

get

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/dns/adm/{network}

HTTPcURLJavaScriptPython

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

[
  {
    "address": "text",
    "address6": "text",
    "name": "text",
    "network": "text"
  }
]

Create a new DNS entry

post

Path parameters

networkstringRequired

Network identifier

Body

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/dns/adm/{network}

HTTPcURLJavaScriptPython

POST /api/dns/adm/{network} HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "address": "text",
  "address6": "text",
  "name": "text",
  "network": "text"
}

{
  "address": "text",
  "address6": "text",
  "name": "text",
  "network": "text"
}

Gets custom DNS entries associated with a network

get

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/api/dns/adm/{network}/custom

HTTPcURLJavaScriptPython

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

[
  {
    "address": "text",
    "address6": "text",
    "name": "text",
    "network": "text"
  }
]

Sync DNS entries for a given network

post

Responses

200

DNS Sync completed successfully

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/dns/adm/{network}/sync

HTTPcURLJavaScriptPython

POST /api/dns/adm/{network}/sync HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

Push DNS entries to nameserver

post

Responses

200

DNS Pushed to CoreDNS

application/json

Responsestring

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/api/dns/adm/pushdns

HTTPcURLJavaScriptPython

POST /api/dns/adm/pushdns HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text