Skip to content
Was this article helpful?


Configuration for 0 resource.


(click to see Operations )

Name Data Type Permissions Description
url <String> Read-write Url for the build file. Must be in the following formats:






y <Boolean> Read-write Do not prompt for yes/no before rebooting.
l <Boolean> Read-write Use this flag to enable callhome.
a <Boolean> Read-write Use this flag to enable Citrix ADM Service Connect. This feature helps you discover your Citrix ADC instances effortlessly on Citrix ADM service and get insights and curated machine learning based recommendations for applications and Citrix ADC infrastructure. This feature lets the Citrix ADC instance automatically send system, usage and telemetry data to Citrix ADM service. View here [] to learn more about this feature. Use of this feature is subject to the Citrix End User ServiceAgreement. View here [].
enhancedupgrade <Boolean> Read-write Use this flag for upgrading from/to enhancement mode.
resizeswapvar <Boolean> Read-write Use this flag to change swap size on ONLY 64bit nCore/MCNS/VMPE systems NON-VPX systems.


(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 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>


Mandatory parameters are marked in red and placeholder content is marked in green


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


Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>


Request Payload:

<b>      "url":<String_value>,
</b>      "y":<Boolean_value>,


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

Was this article helpful?