Product Documentation

Automate NetScaler Upgrade and Downgrade with a Single API

Sep 01, 2016

You can use the "install" API to automate not just installation, but also an upgrade or a downgrade of the build on a NetScaler appliance. You can specify a local or remote location for the build file.

For example, the following information describes a downgrade to NetScaler release 10.5 build 46, using a local  build file:

  • Request

HTTP Method


Request Headers 복사


Content-Type: application/json

Code 복사

Request Payload 복사

         “url”: “file:///var/tagma/build_tagma_46_nc.tgz”


  •  Response

HTTP status Code on Success
         201 Created

209 Netscaler specific warning

Note: when “y” option is not specified and warning is enabled, API returns “1120 - The configuration must be saved and the system rebooted for these settings to take effect” message in X-NITRO-WARNING.

HTTP Status Code on Failure
         599 Netscaler specific error

Additional parameters available in the install API request payload:

                “y”:“true” -  This option enables reboot on successful loading of kernel.

                “L”:“true” -  This option enables the callhome feature.

Supported formats for the "url" parameter (specifies the location of the tar.gz file for the build):

  •  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

Possible errors:

  • Installation failed. [No space on file system. Please check the log file /var/tmp/install​]
  • Installation failed. [File transfer failed]
  • Installation failed. [File does not exist]
  • Installation failed. [Failed to copy file to /var/tmp]
  • Installation failed. [Extraction failed, invalid tar archive?​]
  • Installation failed. [Invalid file transfer protocol]
  • Installation failed. [Unable to create temporary directory]
  • Installation failed. [Please check the log file /var/tmp/install for more information]