nsspparams

Last published : Oct 30, 2026
Configuration for Surge Protection parameter resource.

Properties

(click to see Operations)
Name Data Type Permissions Description
basethreshold <Integer> Read-write Maximum number of server connections that can be opened before surge protection is activated.
Default value: 200
Minimum value = 0
Maximum value = 32767
throttle <String> Read-write Rate at which the system opens connections to the server.
Default value: Normal
Possible values = Aggressive, Normal, Relaxed
table0 <Integer[]> Read-only Table.

Operations

(click to see Properties)
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 Citrix ADC appliance, the URL is as follows:
    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsspparams
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{"nsspparams":{
"basethreshold":<Integer_value>,
"throttle":<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 Citrix ADC specific errors). The response payload provides details of the error

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsspparams?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:

{"nsspparams":{
"basethreshold":true,
"throttle":true
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsspparams
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:

{ "nsspparams": [ {
"basethreshold":<Integer_value>,
"throttle":<String_value>,
"table0":<Integer[]_value>
}]}