Skip to content

dnsrecords

Read/write properties

Properties

(click to see Operations)

NameData TypePermissionsDescription
dnsrecordtype<String>Read-writeDisplay 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<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
dnstotentries<Double>Read-onlyTotal number of DNS record entries
dnstotupdates<Double>Read-onlyTotal number of DNS proactive updates
dnstotresponses<Double>Read-onlyTotal number of DNS server responses
dnstotrequests<Double>Read-onlyTotal number of DNS queries recieved
dnscurentries<Double>Read-onlyCurrent number of DNS entries
dnstoterrlimits<Double>Read-onlyTotal number of times we have recieved dns record with more entries than we support
dnstoterrrespform<Double>Read-onlyTotal number of times we have recieved malformed responses from the backend
dnstoterraliasex<Double>Read-onlyTotal number of times we have recieved non-cname record for a domain for which an alias exists
dnstoterrnodomains<Double>Read-onlyTotal number of cache misses
dnscurrecords<Double>Read-onlyCurrent 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/dnsrecords

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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