ADC NITRO APIs

dnsresolverentry

July 9, 2026

Contributed by:

Configuration for Active DNS resolution entries resource.

Properties

(click to see Operations )

Name	Permissions	Description
detail	Read-write	To get a detailed view of ongoing DNS resolution entries.
nodeid	Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
hostname	Read-only	Domain Name being resolved. Minimum length = 1
nsrectype	Read-only	DNS query type. Possible values = A, NS, CNAME, SOA, MX, AAAA, SRV, RRSIG, NSEC, DNSKEY, PTR, TXT, NAPTR, CAA, SVCB, HTTPS
cnameentry	Read-only	First CName during DNS resolution. Minimum length = 1
dnsqueryid	Read-only	DNS query ID.
passiverips	Read-only	Total number of Passive RIPS attached.
resolutiondepth	Read-only	DNS resolution depth.
cnameresolutiondepth	Read-only	CNAME resolution depth.
sourceip	Read-only	Source IP address.
srcport	Read-only	Source port number. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
destip	Read-only	Destination IP address.
destport	Read-only	Destination port number. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
issecondaryrip	Read-only	Indicates if current DNS resolution rip is secondary or not. Possible values = YES, NO, TCP, UDP
isresolutioninprogress	Read-only	Indicates if DNS resolution is in progress or not. Possible values = YES, NO, TCP, UDP
ispassiverip	Read-only	Indicates if RIP is passive or not. Possible values = YES, NO, TCP, UDP
isloopcase	Read-only	Indicates if DNS resolution is a loop case or not. Possible values = YES, NO, TCP, UDP
isedns	Read-only	Indicates if EDNS is being used or not. Possible values = YES, NO, TCP, UDP
dnsprotocol	Read-only	Indicates the DNS resolution is over TCP or UDP. Possible values = YES, NO, TCP, UDP
activeripdevno	Read-only	Devno of Active/Parent RIP, for passive/secondary rips it is the devno of corresponding active rip.
peid	Read-only	PE where the DNS resolution is taking place. Minimum value = 0 Maximum value = 32
_nextgenapiresource	Read-only	.
__count	Read-only	count parameter

Operations

(click to see Properties )

GET (ALL)
COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? args=detail: <Boolean_value> ,nodeid: <Integer_value>

Use this query-parameter to get dnsresolverentry resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of dnsresolverentry resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? view=summary

Use this query-parameter to get the summary output of dnsresolverentry resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? pagesize=#no;pageno=#no

Use this query-parameter to get the dnsresolverentry resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "dnsresolverentry": [ {
detail:<Boolean_value>,nodeid:<Integer_value>"hostname":<String_value>,
"nsrectype":<String_value>,
"cnameentry":<String_value>,
"dnsqueryid":<Integer_value>,
"passiverips":<Integer_value>,
"resolutiondepth":<Integer_value>,
"cnameresolutiondepth":<Integer_value>,
"sourceip":<String_value>,
"srcport":<Integer_value>,
"destip":<String_value>,
"destport":<Integer_value>,
"issecondaryrip":<String_value>,
"isresolutioninprogress":<String_value>,
"ispassiverip":<String_value>,
"isloopcase":<String_value>,
"isedns":<String_value>,
"dnsprotocol":<String_value>,
"activeripdevno":<Integer_value>,
"peid":<Integer_value>,
"_nextgenapiresource":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnsresolverentry? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "dnsresolverentry": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this product documentation is in English. Any non-English version is solely provided for your convenience and may include machine-translated content. For more information, please refer to the Machine Translation Disclaimer on Cloud Software Group home.

Was this helpful

dnsresolverentry

July 9, 2026

Contributed by:

July 9, 2026

Contributed by:

dnsresolverentry

Properties

Operations

get (all)

count

In this article