Citrix NetScaler NS Config API
NetScaler appliance configuration including IP address, network settings, HTTP ports, and system-level parameters. Supports save, clear, and diff operations.
Citrix NetScaler NS Config 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 NS Config. 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 4 operations across 3 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Citrix NetScaler NS Config 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 4
Across 3 paths, the API surfaces 4 operations — 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
NetScaler appliance configuration including IP address, network settings, HTTP ports, and system-level parameters. Supports save, clear, and diff operations.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are NsConfig (30 properties), NitroErrorResponse (3 properties), NitroResponse (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Citrix NetScaler 8
Other APIs Citrix NetScaler publishes across the network.
This is an independent, third-party profile of Citrix NetScaler NS Config 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.