Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

dnstxtrec

August 17, 2023
Contributed by: 
C

Configuration for TXT record resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
domain Read-write Name of the domain for the TXT record.

Minimum length = 1
String <String[]> Read-write Information to store in the TXT resource record. Enclose the string in single or double quotation marks. A TXT resource record can contain up to six strings, each of which can contain up to 255 characters. If you want to add a string of more than 255 characters, evaluate whether splitting it into two or more smaller strings, subject to the six-string limit, works for you.

Maximum length = 255
ttl Read-write Time to Live (TTL), in seconds, for the record. TTL is the time for which the record must be cached by DNS proxies. The specified TTL is applied to all the resource records that are of the same record type and belong to the specified domain name. For example, if you add an address record, with a TTL of 36000, to the domain name example.com, the TTLs of all the address records of example.com are changed to 36000. If the TTL is not specified, the Citrix ADC uses either the DNS zone’s minimum TTL or, if the SOA record is not available on the appliance, the default value of 3600.

Default value: 3600

Minimum value = 0

Maximum value = 2147483647
recordid Read-write Unique, internally generated record ID. View the details of the TXT record to obtain its record ID. Mutually exclusive with the string parameter.

Minimum value = 1

Maximum value = 65535
ecssubnet Read-write Subnet for which the cached TXT record need to be removed.
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. Default value: ADNS Possible values = ALL, ADNS, PROXY
    		•
    nodeid Read-write Unique number that identifies the cluster node.

    Minimum value = 0

    Maximum value = 31
    authtype Read-only Authentication type.

    Possible values = ALL, ADNS, PROXY
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • 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/dnstxtrec

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"dnstxtrec":{
<b>      "domain":<String_value>,
</b><b>      "String":<String[]_value>,
</b>      "ttl":<Double_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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnstxtrec/ domain_value<String>

    Query-parameters:

    args=String: <String[]_value> ,recordid: <Double_value> ,ecssubnet: <String_value>

    </b>

    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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnstxtrec

    Query-parameters:

    args

    http:// <netscaler-ip-address> /nitro/v1/config/dnstxtrec? args=domain: <String_value> ,type: <String_value> ,nodeid: <Double_value>

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

    attrs

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

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

    view

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

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

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

    
{ "dnstxtrec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value>      "String":<String[]_value>,
      "ecssubnet":<String_value>,
      "ttl":<Double_value>,
      "recordid":<Double_value>,
      "authtype":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/dnstxtrec/ domain_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/dnstxtrec/ domain_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/dnstxtrec/ domain_value<String> ? view=summary

    Use this query-parameter to get the summary output of dnstxtrec 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: 

    
{  "dnstxtrec": [ {
domain:<String_value>,type:<String_value>,nodeid:<Double_value>      "String":<String[]_value>,
      "ecssubnet":<String_value>,
      "ttl":<Double_value>,
      "recordid":<Double_value>,
      "authtype":<String_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    dnstxtrec
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    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.