Skip to end of metadata
Go to start of metadata

View DNS settings

Available in 14 starting with 14.10

Resource URI: /dns/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

path

Path to the setting.

type

Setting type. Possible options are string, boolean or enum.

options

Available setting options.

value

The current selected option of the setting.

defaultValue

The default value of the setting.

label

Setting label.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the settings for all DNSs in the system.

Example: XML format

<Settings>

<Setting>

<path>named-config/forwarders/forwarder_0</path>

<type>string</type>

<value>192.168.1.1</value>

<label>Primary External DNS server</label>

<description>DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8.</description>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_1</path>

<type>string</type>

<label>Secondary External DNS server</label>

<description>In the event the primary DNS server is unavailable, system will use this server.</description>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_2</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_3</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>named-config/forwarders/forwarder_4</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

<Setting>

<path>acl/ips</path>

<type>string</type>

<value>192.168.1.171,127.0.0.0/8</value>

<defaultValue>192.168.1.171,127.0.0.0/8</defaultValue>

<label>Allow Recursion ACL</label>

<description>Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver.</description>

</Setting>

<Setting>

<path>sys/unmanaged</path>

<type>boolean</type>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Unmanaged Service</label>

<description>Company or ITSP DNS servers to resolve ALL names instead of local DNS servers.</description>

</Setting>

JSON format

{

settings: [11]

0: {

path: "named-config/forwarders/forwarder_0"

type: "string"

options: null

value: "192.168.1.1"

defaultValue: null

label: "Primary External DNS server"

description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."

}-

1: {

path: "named-config/forwarders/forwarder_1"

type: "string"

options: null

value: null

defaultValue: null

label: "Secondary External DNS server"

description: "In the event the primary DNS server is unavailable, system will use this server."

}-

2: {

path: "named-config/forwarders/forwarder_2"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

3: {

path: "named-config/forwarders/forwarder_3"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

4: {

path: "named-config/forwarders/forwarder_4"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}-

5: {

path: "acl/ips"

type: "string"

options: null

value: "192.168.1.171,127.0.0.0/8"

defaultValue: "192.168.1.171,127.0.0.0/8"

label: "Allow Recursion ACL"

description: "Groups of hosts (comma separated values of IP addresses or subnet) allowed to make recursive queries on the nameserver. <br/>Leave empty for allowing all hosts to perform recursive queries on the nameserver."

}-

6: {

path: "sys/unmanaged"

type: "boolean"

options: null

value: "0"

defaultValue: "0"

label: "Unmanaged Service"

description: "Company or ITSP DNS servers to resolve ALL names instead of local DNS servers."

}-

7: {

path: "sys/unmanaged_servers/unmanaged_0"

type: "string"

options: null

value: null

defaultValue: null

label: "Primary Unmanaged DNS server"

description: "DNS server in your company or your ITSP. Can also be a publicly available DNS server like 8.8.8.8."

}

}

Unsupported HTTP Method: PUT, POST, DELETE


View DNS settings from path

Available in 14 starting with 14.10

Resource URI: /dns/settings/{settingPath}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

setting

The dns setting related information is similar to the one described under /dns/settings.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the DNS settings from the specified path.

Example: XML format

<Setting>

<path>named-config/forwarders/forwarder_3</path>

<type>string</type>

<label>Additional External DNS server</label>

</Setting>

JSON format

{

path: "named-config/forwarders/forwarder_3"

type: "string"

options: null

value: null

defaultValue: null

label: "Additional External DNS server"

description: null

}

HTTP Method: PUT

Updates the settings of the DNS from the specified path. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the DNS from the specified path.

Unsupported HTTP Method: POST

View DNS adviser results

Available in 14 starting with 14.10

Resource URI: /dns/advisor/server/{serverId}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

Missing naptr records

List of the missing NAPTR records, if any.

Missing a records

List of missing A records, if any.

Specific Response Codes: N/A

HTTP Method: GET

Checks the DNS settings and if the settings are correct, no result is returned. Otherwise, it retrieves the missing configurations.

Example: plain text only

;; Missing naptr records

ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2U" "" _sip._udp

ezuce.ro. IN NAPTR \d 0 "s" "SIP+D2T" "" _sip._tcp

;; Missing a records

Uniteme_1410.ezuce.ro IN A 19.18.1.175

Unsupported HTTP Method: PUT, POST, DELETE

  • No labels