Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nsconfigview

September 25, 2025
Contributed by: 
C

Configuration for 0 resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
state Read-write State is a session-level setting that controls the configuration shown to the user. Based on the selected option user will be able to see only the configuration created through Classic Interface (CLI/API) or Only Configurations created through Next-Gen API, Or both Classic ; Next-Gen API interfaces. Configurations created by Nextgenapi are read-only and can only be modified via Next-Gen API REST endpoints. Configurations created by classic interfaces (CLI, NITRO) are editable for CLASSIC or ALL views. Possible values
  • CLASSIC: Config view is limited to the configuration entities created through classic interfaces (CLI, NITRO). This is the default behaviour.
  • NEXTGENAPI: Config view is limited to the configuration entities created through Next-Gen API Interface.
  • ALL: Configurations created by both Classic and Next-Gen API interfaces are visible. Default value: CLASSIC Possible values = CLASSIC, NEXTGENAPI, ALL
    		•
    _nextgenapiresource Read-only .

    Operations

    (click to see Properties )

    • SWITCH
    • GET (ALL)

    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

    Switch

    URL: http:// <netscaler-ip-address> /nitro/v1/config/nsconfigview? action=Switch

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {"nsconfigview":{
<b>"state":<String_value>
</b>}}


<!--NeedCopy-->

    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/nsconfigview

    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: 

    { "nsconfigview": [ {
"state":<String_value>,
"_nextgenapiresource":<String_value>
}]}


<!--NeedCopy-->
    nsconfigview
    September 25, 2025
    Contributed by: 
    C
    September 25, 2025
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.