Skip to content
Was this article helpful?


Configuration for surge queue resource.


(click to see Operations)

Name Data Type PermissionsDescription
name<String>Read-writeName of a virtual server, service or service group for which the SurgeQ must be flushed.
servername<String>Read-writeName of a service group member. This argument is needed when you want to flush the SurgeQ of a service group.
port<Integer>Read-writeport on which server is bound to the entity(Servicegroup).<br>Range 1 - 65535<br>* in CLI is represented as 65535 in NITRO API


(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 NetScaler appliance, the URL is as follows:


    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:



    Note: In such cases, make sure that the request header DOES not include the following:



Mandatory parameters are marked in red and placeholder content is marked in <green>.


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


Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:



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

Was this article helpful?