device_usage

Last published : Aug 10, 2026
Configuration for Citrix ADC Usage information resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
base_limit <Integer> Read-write Base limit usage for the user (excluding burst).
hostname <String> Read-write Host name of the device.
timeslot <Double> Read-write Device usage information at this timestamp.
total_limit <Integer> Read-write Total license limit for the user (including burst).
timestamp <Double> Read-write Max Device usage information per hour at this timestamp.
id <String> Read-write Id is system generated key.
license_name <String> Read-only License name for the device.
license_usage <Integer> Read-only License used by the Citrix ADC (Bandwidth/vCPU).
ip_address <String> Read-only IP Address of the device.

Operations

(click to see Properties )
  • GET
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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

get

URL: https://<MGMT-IP>/nitro/v2/config/device_usage HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "device_usage":[{
"license_name":<String_value>,
"base_limit":<Integer_value>,
"license_usage":<Integer_value>,
"hostname":<String_value>,
"timeslot":<Double_value>,
"total_limit":<Integer_value>,
"timestamp":<Double_value>,
"id":<String_value>,
"ip_address":<String_value>}]}