Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

aaaproxyparam

July 9, 2026
Contributed by: 
C

Configuration for AAA proxy parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
proxy Read-write IP address and Port of the proxy server to be used for HTTP access for this request. This can be configured in the following manner: First way is to configure in ipaddress:port format like a.b.c.d:e or this can be specified via the alternate format which is to specify like http://a.b.c.d without port or http://a.b.c.d:8080 with port.
Minimum length = 1
proxyauthorization Read-write this indicates whether Proxy-Authorization header will be sent or not.
Default value: PROXY_AUTH_DISABLED
Possible values = disabled, basic
proxyusername Read-write username that will be sent as part of Basic Proxy-Authorization header.
Maximum length = 256
proxypassword Read-write password that will be sent as part of Basic Proxy-Authorization header.
Maximum length = 256
_nextgenapiresource Read-only .

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • 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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/aaaproxyparam HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"aaaproxyparam":{
"proxy":<String_value>,
"proxyauthorization":<String_value>,
"proxyusername":<String_value>,
"proxypassword":<String_value>
}}

<!--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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/aaaproxyparam? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"aaaproxyparam":{
"proxy":true,
"proxyauthorization":true,
"proxyusername":true,
"proxypassword":true
}}

<!--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/aaaproxyparam 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: 

{ "aaaproxyparam": [ {
"proxy":<String_value>,
"proxyauthorization":<String_value>,
"proxyusername":<String_value>,
"proxypassword":<String_value>,
"_nextgenapiresource":<String_value>
}]}

<!--NeedCopy-->
aaaproxyparam
July 9, 2026
Contributed by: 
C
July 9, 2026
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.