Citrix ADC 12.1 NITRO API Reference

dnsnsecrec

Configuration for 0 resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
hostname Read-write Name of the domain.
Minimum length = 1
type Read-write Type of records to display. Available settings function as follows:
* ADNS - Display all authoritative address records.
* PROXY - Display all proxy address records.
* ALL - Display all address records.
Possible values = ALL, ADNS, PROXY
nextnsec Read-only Next nsec record in the chain.
nextrecs <String[]> Read-only An array of record types associated with the nsec record.
Possible values = A, NS, CNAME, SOA, MX, AAAA, SRV, RRSIG, NSEC, DNSKEY, PTR, TXT, NAPTR
ttl Read-only Time to Live (TTL), in seconds, for the record.
ecssubnet Read-only Subnet for which this particular record is cached. Subnet caching will occur for responses with EDNS Client Subnet (ECS) option. Applies to resource records obtained through proxy configurations only.
__count Read-only count parameter

Operations

(click to see Properties)

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/config/dnsnsecrec

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec?args=hostname:<String_value>,type:<String_value>

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

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec?attrs=property-name1,property-name2

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

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec?pagesize=#no;pageno=#no

Use this query-parameter to get the dnsnsecrec 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "dnsnsecrec": [ { hostname:<String_value>,type:<String_value>"nextnsec":<String_value>, "nsecbitarray":<String[]_value>, "nextrecs":<String[]_value>, "ttl":<Double_value>, "ecssubnet":<String_value> }]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec/hostname_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec/hostname_value<String>?attrs=property-name1,property-name2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/dnsnsecrec/hostname_value<String>?view=summary

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

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:

{ "dnsnsecrec": [ { hostname:<String_value>,type:<String_value>"nextnsec":<String_value>, "nsecbitarray":<String[]_value>, "nextrecs":<String[]_value>, "ttl":<Double_value>, "ecssubnet":<String_value> }]}

count

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

Content-Type:application/json

Response Payload:

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