Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

install

June 18, 2026
Contributed by: 
C

Configuration for 0 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
url Read-write Url for the build file. Must be in the following formats http://[user]:[password]@host/path/to/file https://[user]:[password]@host/path/to/file sftp://[user]:[password]@host/path/to/file scp://[user]:[password]@host/path/to/file ftp://[user]:[password]@host/path/to/file file://path/to/file.
Async Read-write Use this flag to return the install id when the nitro api request is sent.
The id can be used later to track the installation progress via show ns job command.
For the cli request of install the flag is by default set as false as the installation progress details can be tracked via cli.
y Read-write Do not prompt for yes/no before rebooting.
l Read-write Use this flag to enable callhome.
a 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 [https://docs.citrix.com/en-us/citrix-adc/13/data-governance.html] to learn more about this feature. Use of this feature is subject to the Citrix End User ServiceAgreement. View here [https://www.citrix.com/buy/licensing/agreements.html].
fipsinstall Read-write Use this flag to perform FIPS installation.
answeryestoall Read-write Use this flag to answer yes to all prompts.
dontreboot Read-write Use this flag to prevent reboot after installation when answerYesToAll is true.
dontchecknsconf Read-write Use this flag to skip ns.conf version equivalence check during downgrade.
deletesigfiles Read-write Use this flag to delete all signature files and associated kernel images during installation.
ignorensapimgrerrors Read-write Use this flag to ignore nsapimgr symbols not found error(s) during installation.
exitonlicserverconnerror Read-write Use this flag to exit on license server connectivity errors.
precheck Read-write Use this flag to run all installation pre-checks in a single step.
advancedoptions Read-write Use this string to pass extra flags which are not yet supported.
Example: -flag1 -flag2 -flag3.
ignoreunsavedconfig Read-write Use this flag to ignore unsaved config check during build update.
ignoreunsyncedconfig Read-write Use this flag to ignore unsynced HA config check during build update.
ignorecertcheckerrors Read-write Use this flag to ignore certificate digest verification errors during build update.
id Read-only Job Id for install process.

Operations

(click to see Properties )

  • INSTALL

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

Install

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

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"install":{
<b>"url":<String_value>,
</b>"Async":<Boolean_value>,
"y":<Boolean_value>,
"l":<Boolean_value>,
"a":<Boolean_value>,
"fipsinstall":<Boolean_value>,
"answeryestoall":<Boolean_value>,
"dontreboot":<Boolean_value>,
"dontchecknsconf":<Boolean_value>,
"deletesigfiles":<Boolean_value>,
"ignorensapimgrerrors":<Boolean_value>,
"exitonlicserverconnerror":<Boolean_value>,
"precheck":<Boolean_value>,
"advancedoptions":<String_value>,
"ignoreunsavedconfig":<Boolean_value>,
"ignoreunsyncedconfig":<Boolean_value>,
"ignorecertcheckerrors":<Boolean_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

Response Payload: 

{ "install": [ {
"id":<Integer_value>

}]}

<!--NeedCopy-->
install
June 18, 2026
Contributed by: 
C
June 18, 2026
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.