JSON Object Sample
{
    "Timeout": 0,
    "DNSServer": "A.ROOT-SERVERS.NET",
    "HostNameToResolve": "nasa.org",
    "RecordType": "A",
    "RecursionDesiredFlag": "YES",
    "Protocol": "TCP",
    "VerifyResponseFrom": "All Servers",
    "ServersTimeoutFilter": "*",
    "ExpectedAnswer": "",
    "ExpectedAuthority": "",
    "ExpectedAdditional": "",
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "Device_Id": 263128,
    "Id": 481268,
    "Task_Type_Id": 8,
    "Name": "tcp"
}

Fields Description

Field Type Required/Optional Description

DNSServer

string

optional

 The DNS server address. By default, we use the a.root-servers.net root server.

Example:
"DNSServer": "8.8.8.8"

HostNameToResolve

string

required

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

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

POSSIBLE VALUES:

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

Example:

"RecordType": "CNAME"
Protocol string required The protocol to use on DNS lookup.

POSSIBLE VALUES:

  • Auto
  • TCP
  • UDP
RecursionDesiredFlag string required Enables or disables the recursion desired (RD) flag in outgoing DNS queries.

POSSIBLE 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 required Defines how a DNS  answers with a required record type are interpreted.

POSSIBLE VALUES:

  • All Servers –  answers only from end-leaves of DNS tree are verified for proper response.
  • First Server – only the first found answer with the 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 optional Filtering for network and time-out errors from exact hosts, or a range of nodes based on a mask.

POSSIBLE VALUES:

  • * –  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 – the engine ignores all network-related and timeout errors of the matching host or IP address.
Example:
"VerifyResponseFrom": "2001:501:*"
ExpectedAnswer string optional Validates content in appropriate sections of the nameserver answer; i.e. Expected value of the “answer” section.
ExpectedAuthority string optional Validates content in appropriate sections of the nameserver answer; i.e. Expected value of the  “Authority” section.
ExpectedAdditional string optional Validates content in appropriate sections of the nameserver answer; i.e. Expected value of the “Additional” section.
DNSResolveMode string optional POSSIBLE VALUES:

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

For detailed explanation, see the DNS Mode Option article.
DNSserverIP string The field for a custom DNS server IP address, for a detailed explanation please see “DNS Mode Option” article
Device_Id

int32

required

 READ ONLY Field. The unique device id.

Example:
"Device_Id": 17716
Id int32

required

*Only for edit operations

 READ ONLY Field.The unique task id. Do not use for create operations.

Example:
"Id": 100356

Task_Type_Id

int32

required

 The type id of the task.

Example:
"Task_Type_Id": 8

Name

string

optional

 The task name.

Example:
"Name": "Google DNS"

Timeout

int32

optional

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

Example:
"Timeout": 0