apispec

Last published : Oct 30, 2026
Configuration for API specification resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
name <String> Read-write Name for the spec. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the spec is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my spec" or 'my spec').
Minimum length = 1
file <String> Read-write Name of and, optionally, path to the api spec file. The spec file should be present on the appliance's hard-disk drive or solid-state drive. Storing a spec file in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/apispec/ is the default path.
Minimum length = 1
type <String> Read-write Input format of the spec file. The three formats supported by the appliance are:
PROTO
OAS/Swagger
GRAPHQL.
Default value: OAS
Possible values = PROTO, OAS, GRAPHQL
skipvalidation <String> Read-write Disabling openapi spec validation while adding it.
Default value: NO
Possible values = YES, NO
encrypted <Boolean> Read-write Specify the encrypted API spec. Must be in NetScaler format.
builtin <String[]> Read-only .
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
ready <String> Read-only Indicates whether apec is ready, that is internal registry created or not.
Default value: NO
Possible values = YES, NO
nsappversion <String> Read-only NS App Version of the api spec file.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • GET (ALL)
  • GET
  • COUNT
  • DELETE
  • CHANGE
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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"apispec":{
<b>"name":<String_value>,
</b><b>"file":<String_value>,
</b>"type":<String_value>,
"skipvalidation":<String_value>,
"encrypted":<Boolean_value>
}}
Response: HTTP Status Code on Success: 201 Created
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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec/ name_value<String> HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
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

change

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec? action=update HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"apispec":{
<b>"name":<String_value>,
</b><b>"file":<String_value>,
</b>"type":<String_value>,
"skipvalidation":<String_value>
}}
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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/apispec? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/apispec? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of apispec resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/apispec? view=summary
Use this query-parameter to get the summary output of apispec resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/apispec? pagesize=#no;pageno=#no
Use this query-parameter to get the apispec resources in chunks.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
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 Header:
Content-Type:application/json
Response Payload:
{ "apispec": [ {
"name":<String_value>,
"file":<String_value>,
"type":<String_value>,
"skipvalidation":<String_value>,
"encrypted":<Boolean_value>,
"builtin":<String[]_value>,
"ready":<String_value>,
"nsappversion":<String_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/apispec/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/apispec/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of apispec resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
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 Header:
Content-Type:application/json
Response Payload:
{  "apispec": [ {
"name":<String_value>,
"file":<String_value>,
"type":<String_value>,
"skipvalidation":<String_value>,
"encrypted":<Boolean_value>,
"builtin":<String[]_value>,
"ready":<String_value>,
"nsappversion":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec? count=yes HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
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 Header:
Content-Type:application/json
Response Payload:
{ "apispec": [ { "__count": "#no"} ] }