DNS

Get all DNS entries

get

Authorizations

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

500

Internal Server Error

application/json

get/api/dns

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

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

Create a new DNS entry

post

Authorizations

Path parameters

networkstringRequired

Network identifier

Body

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/api/dns/{network}

POST /api/dns/{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"
}

Delete a DNS entry

delete

Authorizations

Path parameters

networkstringRequired

Network identifier

domainstringRequired

Domain Name

Responses

200

OK

application/json

stringOptional

500

Internal Server Error

application/json

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

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

text

Get all DNS entries associated with the network

get

Authorizations

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

500

Internal Server Error

application/json

get/api/dns/adm/{network}

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

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

Gets custom DNS entries associated with a network

get

Authorizations

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

500

Internal Server Error

application/json

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

GET /api/dns/adm/{network}/custom 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

Authorizations

Path parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

addressstringOptional

address6stringOptional

namestring · min: 1 · max: 192Required

networkstringOptional

500

Internal Server Error

application/json

get/api/dns/adm/{network}/nodes

GET /api/dns/adm/{network}/nodes 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

Authorizations

Path parameters

networkstringRequired

Network identifier

Responses

200

DNS Sync completed successfully

application/json

stringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

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

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

text

Push DNS entries to nameserver

post

Authorizations

Responses

200

DNS Pushed to CoreDNS

application/json

stringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/api/dns/adm/pushdns

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

text

List Nameservers

get

Authorizations

Query parameters

networkstringRequired

Network identifier

Responses

200

OK

application/json

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

descriptionstringOptional

fallbackbooleanOptional

idstringOptional

match_allbooleanOptional

match_domainsstring[]Optional

TODO: deprecate

namestringOptional

network_idstringOptional

serversstring[]Optional

statusbooleanOptional

updated_atstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/v1/nameserver

GET /api/v1/nameserver?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "created_at": "text",
    "created_by": "text",
    "default": true,
    "description": "text",
    "domains": [
      {
        "domain": "text",
        "is_search_domain": true
      }
    ],
    "fallback": true,
    "id": "text",
    "match_all": true,
    "match_domains": [
      "text"
    ],
    "name": "text",
    "network_id": "text",
    "nodes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "servers": [
      "text"
    ],
    "status": true,
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "updated_at": "text"
  }
]

Create Nameserver

post

Authorizations

Body

descriptionstringOptional

match_domainstringOptional

namestringOptional

networkstringOptional

serversstring[]Optional

statusbooleanOptional

tagsstring[]Optional

Responses

200

OK

application/json

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

descriptionstringOptional

fallbackbooleanOptional

idstringOptional

match_allbooleanOptional

match_domainsstring[]Optional

TODO: deprecate

namestringOptional

network_idstringOptional

serversstring[]Optional

statusbooleanOptional

updated_atstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/api/v1/nameserver

POST /api/v1/nameserver HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "description": "text",
  "match_domain": "text",
  "name": "text",
  "network": "text",
  "servers": [
    "text"
  ],
  "status": true,
  "tags": [
    "text"
  ]
}

{
  "created_at": "text",
  "created_by": "text",
  "default": true,
  "description": "text",
  "domains": [
    {
      "domain": "text",
      "is_search_domain": true
    }
  ],
  "fallback": true,
  "id": "text",
  "match_all": true,
  "match_domains": [
    "text"
  ],
  "name": "text",
  "network_id": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "servers": [
    "text"
  ],
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text"
}

Update Nameserver

put

Authorizations

Body

descriptionstringOptional

match_domainstringOptional

namestringOptional

networkstringOptional

serversstring[]Optional

statusbooleanOptional

tagsstring[]Optional

Responses

200

OK

application/json

created_atstringOptional

created_bystringOptional

defaultbooleanOptional

descriptionstringOptional

fallbackbooleanOptional

idstringOptional

match_allbooleanOptional

match_domainsstring[]Optional

TODO: deprecate

namestringOptional

network_idstringOptional

serversstring[]Optional

statusbooleanOptional

updated_atstringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put/api/v1/nameserver

PUT /api/v1/nameserver HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "description": "text",
  "match_domain": "text",
  "name": "text",
  "network": "text",
  "servers": [
    "text"
  ],
  "status": true,
  "tags": [
    "text"
  ]
}

{
  "created_at": "text",
  "created_by": "text",
  "default": true,
  "description": "text",
  "domains": [
    {
      "domain": "text",
      "is_search_domain": true
    }
  ],
  "fallback": true,
  "id": "text",
  "match_all": true,
  "match_domains": [
    "text"
  ],
  "name": "text",
  "network_id": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "servers": [
    "text"
  ],
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text"
}

Delete Nameserver Resource

delete

Authorizations

Query parameters

idstringRequired

Nameserver ID

Responses

200

OK

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete/api/v1/nameserver

DELETE /api/v1/nameserver?id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

text

List Global Nameservers

get

Authorizations

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/api/v1/nameserver/global

GET /api/v1/nameserver/global HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "created_at": "text",
    "created_by": "text",
    "default": true,
    "description": "text",
    "domains": [
      {
        "domain": "text",
        "is_search_domain": true
      }
    ],
    "fallback": true,
    "id": "text",
    "match_all": true,
    "match_domains": [
      "text"
    ],
    "name": "text",
    "network_id": "text",
    "nodes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "servers": [
      "text"
    ],
    "status": true,
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "updated_at": "text"
  }
}