How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Citrix NetScaler System API

System-level resources for managing the NetScaler appliance including system information, files, users, groups, and global settings.

Citrix NetScaler System API is one of 9 APIs that Citrix NetScaler publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a getting-started guide, a changelog, and 1 JSON Schema.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 14.1.

Requests are made against a single base URL, https://{nsip}/nitro/v1.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
14.1
Base URL
https:///nitro/v1
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Citrix NetScaler System API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as NITRO_AUTH_TOKEN (nitroAuthToken). An API key is passed in the header as X-NITRO-USER (nitroBasicAuth). By default, every request must be authenticated.

  • nitroAuthToken — Session-based authentication token obtained via the /config/login endpoint. Provided as a cookie with each request.
  • nitroBasicAuth — Per-request authentication using X-NITRO-USER and X-NITRO-PASS headers as an alternative to session-based tokens.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

System 3

System-level resources for managing the NetScaler appliance including system information, files, users, groups, and global settings.

GET
/config/systemfile
Citrix Netscaler List System Files
listSystemFiles 1 param → 200401
POST
/config/systemfile
Citrix Netscaler Upload a System File
uploadSystemFile body → 201401
DELETE
/config/systemfile/{filename}
Citrix Netscaler Delete a System File
deleteSystemFile 2 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SystemFile (8 properties), NitroResponse (3 properties), NitroErrorResponse (3 properties). Each schema is shown below with its type and property counts.

NitroErrorResponse
object
NITRO API error response with details about the failure.
3 properties
NitroResponse
object
Standard NITRO API success response.
3 properties
SystemFile
object
A system file on the NetScaler appliance.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

citrix-netscaler-system-api-openapi.yml Raw ↑

Other APIs Citrix NetScaler publishes across the network.

NetScaler ADM NITRO API
NetScaler SDX NITRO API
NetScaler Next-Gen API
Citrix NetScaler Authentication API
Citrix NetScaler CS Virtual Server API
Citrix NetScaler LB Virtual Server API
Citrix NetScaler NS Config API
Citrix NetScaler Statistics API
Where this information came from

This is an independent, third-party profile of Citrix NetScaler System API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.