Download full document:


Configuration for vpn user report resource.

(click to see Operations)


(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writevpn user name..
Maximum length = 255
rpt_sample_time<Double>Read-writeReport Sample time..
total_bytes<Double>Read-writeTotal bytes accounted by this URL in sampled timeframe..
max_transaction_time<Double>Read-writeLast Transaction Time for this URL in the sampled timeframe..
id<String>Read-writevpn user name.
Maximum length = 255
total_requests<Double>Read-writeTotal Requests for this device in given sampled timeframe..


(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>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/vpn_user

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "vpn_user":[{