ns_conf

Last published : Aug 10, 2026
Configuration for Configuration diff resource for Citrix ADC resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
ns_ip_address <String> Read-write List of Citrix ADC IP Address. Minimum length = 1 Maximum length = 64
id <String> Read-write Id is system generated key for all ns.conf files.
diff_reportname <String> Read-only Name of the SavedVsRunning diff reportname.
hostname <String> Read-only Host Name of the device.
diff_status <String> Read-only Tells whether a diff exists between running and saved configuration on NS.
display_name <String> Read-only Display Name of the device.
last_updated_time <Integer> Read-only Last Updated Time.
templatediff_reportname <String> Read-only Name of the Template diff reports.
templatediff_status <String> Read-only Tells whether a diff exists between templates associated to Citrix ADC and the running configuration.

Operations

(click to see Properties )
  • INVENTORY
  • DOWNLOAD_CONF
  • GET (ALL)
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

inventory

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf?action=inventory;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": {
"ns_ip_address":<String_value>,
"id":<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":[{
"diff_reportname":<String_value>,
"hostname":<String_value>,
"diff_status":<String_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"templatediff_reportname":<String_value>,
"id":<String_value>,
"templatediff_status":<String_value>,
"last_updated_times":<String_value>}]}

download_conf

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf?action=download_conf;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": {
"ns_ip_address":<String_value>,
"id":<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":[{
"diff_reportname":<String_value>,
"hostname":<String_value>,
"diff_status":<String_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"templatediff_reportname":<String_value>,
"id":<String_value>,
"templatediff_status":<String_value>,
"last_updated_times":<String_value>}]}

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_conf Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/ns_conf ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_conf resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_conf ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_conf resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/ns_conf ?count=yes Use this query-parameter to get the count of ns_conf resources.
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":[{
"diff_reportname":<String_value>,
"hostname":<String_value>,
"diff_status":<String_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"last_updated_time":<Integer_value>,
"templatediff_reportname":<String_value>,
"id":<String_value>,
"templatediff_status":<String_value>,
"last_updated_times":<String_value>}]}