Product Documentation

NITRO API

May 04, 2017

The Citrix NetScaler SDX NITRO protocol allows you to configure and monitor the NetScaler SDX appliance programmatically.

NITRO exposes its functionality through Representational State Transfer (REST) interfaces. Therefore, NITRO applications can be developed in any programming language. Additionally, for applications that must be developed in Java or .NET or Python, the NITRO protocol is exposed as relevant libraries that are packaged as separate Software Development Kits (SDKs).

Note: You must have a basic understanding of the NetScaler SDX appliance before using NITRO.

To use the NITRO protocol, the client application needs the following:

  • Access to a NetScaler SDX appliance.

  • To use REST interfaces, you must have a system to generate HTTP or HTTPS requests (payload in JSON format) to the NetScaler SDX appliance. You can use any programming language or tool.

  • For Java clients, you must have a system where Java Development Kit (JDK) 1.5 or above version is available. The JDK can be downloaded from http://www.oracle.com/technetwork/java/javase/downloads/index.html.

  • For .NET clients, you must have a system where .NET framework 3.5 or above version is available. The .NET framework can be downloaded from http://www.microsoft.com/downloads/en/default.aspx.

  • For Python clients, you must have a system where Python 2.7 or above version and the Requests library (available in <NITRO_SDK_HOME>/lib) is installed.