Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

dnszone

May 23, 2024
Contributed by: 
C

Configuration for DNS zone resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
zonename Read-write Name of the zone to create.

Minimum length = 1
proxymode Read-write Deploy the zone in proxy mode. Enable in the following scenarios
  • The load balanced DNS servers are authoritative for the zone and all resource records that are part of the zone.
  • The load balanced DNS servers are authoritative for the zone, but the Citrix ADC owns a subset of the resource records that belong to the zone (partial zone ownership configuration). Typically seen in global server load balancing (GSLB) configurations, in which the appliance responds authoritatively to queries for GSLB domain names but forwards queries for other domain names in the zone to the load balanced servers. In either scenario, do not create the zone’s Start of Authority (SOA) and name server (NS) resource records on the appliance. Disable if the appliance is authoritative for the zone, but make sure that you have created the SOA and NS records on the appliance before you create the zone. Default value: YES Possible values = YES, NO
    		•
    dnssecoffload Read-write Enable dnssec offload for this zone.

    Default value: DISABLED

    Possible values = ENABLED, DISABLED
    nsec Read-write Enable nsec generation for dnssec offload.

    Default value: DISABLED

    Possible values = ENABLED, DISABLED
    keyname <String[]> Read-write Name of the public/private DNS key pair with which to sign the zone. You can sign a zone with up to four keys.

    Minimum length = 1
    type Read-write Type of zone to display. Mutually exclusive with the DNS Zone (zoneName) parameter. Available settings function as follows
  • ADNS - Display all the zones for which the Citrix ADC is authoritative.
  • PROXY - Display all the zones for which the Citrix ADC is functioning as a proxy server.
  • ALL - Display all the zones configured on the appliance. Possible values = ALL, ADNS, PROXY
    		•
    flags Read-only Flags controlling display.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • UPDATE
    • UNSET
    • DELETE
    • SIGN
    • UNSIGN
    • GET (ALL)
    • GET
    • 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

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"dnszone":{
<b>"zonename":<String_value>,
</b><b>"proxymode":<String_value>,
</b>"dnssecoffload":<String_value>,
"nsec":<String_value>
}}

<!--NeedCopy-->

    Response: HTTP Status Code on Success: 201 Created

    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

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"dnszone":{
<b>"zonename":<String_value>,
</b>"proxymode":<String_value>,
"dnssecoffload":<String_value>,
"nsec":<String_value>
}}

<!--NeedCopy-->

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone? action=unset HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"dnszone":{
<b>"zonename":<String_value>,
</b>"proxymode":true,
"dnssecoffload":true,
"nsec":true
}}

<!--NeedCopy-->

    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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone/ zonename_value<String> HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    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

    sign

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone? action=sign HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"dnszone":{
<b>"zonename":<String_value>,
</b>"keyname":<String[]_value>
}}

<!--NeedCopy-->

    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

    unsign

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone? action=unsign HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"dnszone":{
<b>"zonename":<String_value>,
</b>"keyname":<String[]_value>
}}

<!--NeedCopy-->

    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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/dnszone? args=zonename: <String_value> ,type: <String_value>

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

    attrs http:// <netscaler-ip-address> /nitro/v1/config/dnszone? 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/dnszone? filter=property-name1:property-val1,property-name2:property-val2

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

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

    Use this query-parameter to get the summary output of dnszone 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/dnszone? pagesize=#no;pageno=#no

    Use this query-parameter to get the dnszone 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: 

    { "dnszone": [ {
zonename:<String_value>,type:<String_value>"proxymode":<String_value>,
"flags":<Double_value>,
"nsecbitarray":<String[]_value>,
"dnssecoffload":<String_value>,
"nsec":<String_value>,
"keyname":<String[]_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone/ zonename_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/dnszone/ zonename_value<String> ? attrs=property-name1,property-name2

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

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

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

    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 NetScaler-specific errors). The response payload provides details of the error

    Response Header:

    Content-Type:application/json

    Response Payload: 

    {  "dnszone": [ {
zonename:<String_value>,type:<String_value>"proxymode":<String_value>,
"flags":<Double_value>,
"nsecbitarray":<String[]_value>,
"dnssecoffload":<String_value>,
"nsec":<String_value>,
"keyname":<String[]_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnszone? 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: 

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

<!--NeedCopy-->
    dnszone
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.