API: DNS

JSON Object Example

Fields description 

 

Field Type Description

DNSServer

String

DNS server address

Example:
"DNSServer""8.8.8.8"

HostNameToResolve

String

Defines host name you want to be resolved by the (above) DNS Server.

Example:
"HostNameToResolve""google.com"
RecordType String Defines what NS record type is used for querying during DNS server polling.Available Values:

  • A
  • AAAA
  • NS
  • CNAME
  • SOA
  • TXT
  • MX
  • PTR
  • SPF

“PTR” Record Type causes a reverse DNS look-up. Host name to Resolve in this case should contain a reversed IP address in the following format:

For IPv4:

56.34.12.10.in-addr.arpa.

where “56.34.12.10” is reversed IP address which is 10.12.34.56 in the original.

For IPv6:

A reverse DNS look-up uses the special domain “ip6.arpa.”:

5.4.3.2.1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.

where “5.4.3.2.1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2” is a reversed IP address. 2001:0db8::1:2345 is the non-reversed original.

Example:
"RecordType""CNAME",
RecursionDesiredFlag String Enables or disables the recursion desired (RD) flag in outgoing DNS queries.Available Values:

  •  NO – DNS tool will not send an RD flag.
  •  YES – requests that the DNS server perform recursion for the monitoring service (ie. the remote server will scan a DNS tree for the monitoring service in search of an appropriate result).*
*Client applications (such as Internet browsers) typically use the RD flag.
Example:
"RecursionDesiredFlag""YES"
VerifyResponseFrom String Defines how a DNS  answers with a required record type are interpreted.Available Values:

  •   All Servers –  answers only from end-leaves of DNS tree are verified for proper response.
  •   First Server – only the first found answer with a desired record type is further analyzed. The first appropriate answer is also considered the end of a DNS tree.
Example:
"VerifyResponseFrom""All Servers"
ServersTimeoutFilter String Filtering for out network and time-out errors from exact hosts, or a range of nodes based on a mask.* symbol –  engine ignores all network-related and timeout errors.Empty field – all network-related and timeout errors are included and will trigger alerting.

If a mask is added – engine ignores all network-related and timeout errors of the matching host or IP address.

Example:
"VerifyResponseFrom""2001:501:*"

or

Example:
"VerifyResponseFrom""len*a.ru"
or
Complex Example:
"VerifyResponseFrom""2001:501:* ; len*ra.ru"
ExpectedAnswer String Validates content in appropriate sections of the nameserver answer; i.e. Expected value of “answer” section.
ExpectedAuthority String Validates content in appropriate sections of the nameserver answer; i.e. Expected value of “Authority” section.
ExpectedAdditional String Validates content in appropriate sections of the nameserver answer; i.e. Expected value of “Additional” section.
DNSResolveMode String Available modes:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation please see “DNS Mode Option” article

DNSserverIP String Field for a custom DNS server IP addressFor detailed explanation please see “DNS Mode Option” article

Int32

READ ONLY Field.Unique device ID

Example:
"Device_Id": 8550
Device_Id

Int32

READ ONLY Field.Unique device id

Example:
"Id": 17716
Id int32 READ ONLY Field.Unique task id

Example:
"Id": 100356

Task_Type_Id

Int32

Type of the task field. Please check Potential values for “Task_type_id” in appropriate table

Example:
"Task_Type_Id": 8

Name

String

Task name

Example:
"Name""Google DNS"

Timeout

Int32

This field defines maximum time value (in milliseconds) for task execution.

Example:
"Timeout": 0