ADC NITRO APIs

dnsrecords

August 17, 2023

Contributed by:

Read/write properties

Properties

(click to see Operations )

Name	Permissions	Description
dnsrecordtype	Read-write	Display statistics for the specified DNS record or query type or, if a record or query type is not specified, statistics for all record types supported on the Citrix ADC.
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
dnstotentries	Read-only	Total number of DNS record entries
dnstotupdates	Read-only	Total number of DNS proactive updates
dnstotresponses	Read-only	Total number of DNS server responses
dnstotrequests	Read-only	Total number of DNS queries recieved
dnscurentries	Read-only	Current number of DNS entries
dnstotqueryforexpiredrecord	Read-only	Total number of times query was received for expired record
dnstoterrlimits	Read-only	Total number of times we have recieved dns record with more entries than we support
dnstoterrrespform	Read-only	Total number of times we have recieved malformed responses from the backend
dnstoterraliasex	Read-only	Total number of times we have recieved non-cname record for a domain for which an alias exists
dnstoterrnodomains	Read-only	Total number of cache misses
dnscurrecords	Read-only	Current number of DNS Records

Operations

(click to see Properties )

GET (ALL)
GET

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/stat/dnsrecords

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/dnsrecords? args=dnsrecordtype: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

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

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:

{  "dnsrecords": [ {
      "dnsrecordtype":<String_value>,
      "dnstotupdates":<Double_value>,
      "dnstotentries":<Double_value>,
      "dnstoterrnodomains":<Double_value>,
      "dnstotqueryforexpiredrecord":<Double_value>,
      "dnstoterraliasex":<Double_value>,
      "dnscurentries":<Double_value>,
      "dnscurrecords":<Double_value>,
      "dnstoterrlimits":<Double_value>,
      "dnstotrequests":<Double_value>,
      "dnstotresponses":<Double_value>,
      "dnstoterrrespform":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/dnsrecords/ dnsrecordtype_value><String>

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:

{  "dnsrecords": [ {
      "dnsrecordtype":<String_value>,
      "dnstotupdates":<Double_value>,
      "dnstotentries":<Double_value>,
      "dnstoterrnodomains":<Double_value>,
      "dnstotqueryforexpiredrecord":<Double_value>,
      "dnstoterraliasex":<Double_value>,
      "dnscurentries":<Double_value>,
      "dnscurrecords":<Double_value>,
      "dnstoterrlimits":<Double_value>,
      "dnstotrequests":<Double_value>,
      "dnstotresponses":<Double_value>,
      "dnstoterrrespform":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

dnsrecords

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

dnsrecords

Properties

Operations

get (all)

get

In this article