ns_conf_download_policy

Last published : Aug 10, 2026
Configuration for Citrix ADC Configuration (ns.conf) Download Policy resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
interval_unit <String> Read-write This property is deprecated, polling interval will be provided in minutes only;ltbr;gtFrequency unit (Minutes).
polling_interval <Integer> Read-write Frequency of polling in minutes. Minimum value = 30 Maximum value =
ns_ip_address <String[]> Read-write List of Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
act_id <String> Read-write Activity ID that is used to track the polling status using resource poll_activity_status..

Operations

(click to see Properties )
  • DO_POLL
  • GET
  • UPDATE
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

do_poll

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf_download_policy?action=do_poll;onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_conf_download_policy": {
<b>"polling_interval":<Integer_value></b>,
"ns_ip_address":<String_value[]>,
"act_id":<String_value>,
"interval_unit":<String_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_conf_download_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf_download_policy HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_conf_download_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf_download_policy/ HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"ns_conf_download_policy":{
<b>"polling_interval":<Integer_value></b>,
"ns_ip_address":<String_value[]>,
"act_id":<String_value>,
"interval_unit":<String_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_conf_download_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}