--- title: "Get Appliance Stats." slug: "get-appliance-stats" updated: 2026-03-02T22:30:52Z published: 2026-03-02T22:35:48Z canonical: "support.appgate.com/get-appliance-stats" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.appgate.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Appliance Stats. GetDeprecated/stats/appliances Get Stats and status of the active appliances. This API makes the controller to query every active appliance for status. The operation may take long if one or more appliances take long to respond. **Note:** if identical filter keys are chained with '&', the first filter is applied and the rest are ignored. Deprecated as of 6.3. Use `/appliances/status` instead. SecurityHTTPType bearer Query parametersquerystring Query string to filter the result list. It's used for various fields depending on the object type. Send multiple query parameters to make the queries more specific. rangestring 'Range string to limit the result list. Format: -. 3-10 means the items between the (including) 3rd and the 10th will be returned. Defaults to all objects.' Example0-10 orderBystring The field name to sort the result list. Supported fields vary from object to object. Defaults to certain field depending on the object type. Examplename descendingstring Whether the sorting is applied descending or ascending. Defaults to certain field depending on the object type. filterBy Filters the result list by the given field and value. Supported fields vary from API to API. The filters can be combined with each other as well as the generic query parameter. The given value is checked for inclusion. object property*string additionalProperties Example{ "name": "us-east", "tags": "aws" } Responses200 Active Appliances stats. Expand Allobject rangestring The range applied to the list. Format: -/. 3-5/8 means, out of 8 count (query affects the total), the items between (including) the 3rd and the 5th are returned. Example0-30/54 orderBystring The field name used to sort the list. Examplename descendingboolean Whether the sorting is applied descending or ascending. queries Array of string The queries applied to the list. string totalCountinteger The total readable count of entities. Not influenced by the query. Example328 filterBy Array of object (FilterBy) The filters applied to the list. object namestring The field name the filter is applied to. Examplename valuestring The value used for comparison. ExampleAWS controllerCountnumber The number of active Appliances with the Controller role enabled. Example2.0 gatewayCountnumber The number of active Appliances with the Gateway role enabled. Example12.0 applianceCountnumber The number of active Appliances in total. Example14.0 logServerCountnumber The number of active Appliances with the LogServer role enabled. Example1.0 logForwarderCountnumber The number of active Appliances with the LogForwarder role enabled. Example0.0 connectorCountnumber The number of active Appliances with the Connector role enabled. Example6.0 portalCountnumber The number of active Appliances with the Portal role enabled. Example6.0 data Array of object object An active Appliance status details. idstring (uuid) ID of the Appliance. Example4c07bc67-57ea-42dd-b702-c2d6c45419fc namestring Name of the Appliance. ExampleController1 siteNamestring Name of the Site for this Appliance. ExampleDefault Site tags Array of string Tags of the Appliance. Example[ "developer", "api-created" ]string onlineboolean Deprecated Whether the Appliance is reachable by the Controller or not. Deprecated as of 5.1. "status" field will be set to "offline" instead. versionstring The Appliance build version. Example4.2.0-12161-release statestring State of the Appliance. For internal use. Examplecontroller_ready volumeNumbernumber The volume number in use. Example1.0 statusstring Aggregated status of the Appliance. Valid values[ "healthy", "busy", "warning", "error", "n/a", "offline" ] functionstring Comma-separated list of functions enabled on this Appliance in short format. ExampleCTR, GW, LS controllerobject statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. maintenanceModeboolean Whether the maintenance mode is active or not on this Controller. databaseSizestring Database size. logServerobject (ApplianceRole) Status of the given role for an Appliance. statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. logForwarderobject (ApplianceRole) Status of the given role for an Appliance. statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. gatewayobject statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. numberOfSessionsinteger Number of active sessions on the Gateway or Portal. Example156 connectorobject statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. numberOfSessionsinteger Number of active sessions on the Gateway or Portal. Example156 portalobject statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. numberOfSessionsinteger Number of active sessions on the Gateway or Portal. Example156 applianceobject statusstring Status of the role. Valid values[ "healthy", "busy", "warning", "error", "n/a" ] detailsstring Optional details for extra information like error messages. ExampleCannot reach appliance. Please check Controller logs. logDestinationstring Where the audit logs being sent to. numberOfSessionsinteger Number of sessions on Gateway, Portal or Connector. Example241 cpunumber (float) Current CPU utilization % on the Appliance. Example1.2 memorynumber (float) Current memory reserved % on the Appliance. Example21.5 disknumber (float) Current disk usage % on the Appliance. Example1.2 diskInfoobject Disk usage information. totalnumber (long) Total disk space in bytes. Example20735209472.0 usednumber (long) Used disk space in bytes. Example120324096.0 freenumber (long) Free disk space in bytes. Example19537997824.0 networkobject Current network utilization on the Appliance. busiestNicstring The name of the NIC that's most used. Exampleeth1 dropinnumber Number of inbound packets dropped for the whole uptime. Example2563.0 dropoutnumber Number of outbound packets dropped for the whole uptime. Example120.0 rxSpeedstring The speed of the inbound network activity on the busiest NIC. The average is taken for the last 10 seconds. Example5.77 Kbps txSpeedstring The speed of the outbound network activity on the busiest NIC. The average is taken for the last 10 seconds. Example8.53 Kbps ipsobject IPs of the Appliance per NIC. Example{ "eth0": [ "10.0.0.1", "abba::cafe" ], "eth1": [ "200.123.123.12" ] }property* Array of string additionalPropertiesstring upgradeobject Upgrade Status if there is one going. statusstring The Upgrade status Exampleinstalling detailsstring Optional details for the current Upgrade Status. Examplea reboot is required for the upgrade to go into effect customizationNamestring The name of the Appliance Customization if one is assigned to this Appliance. ExampleMyAgent 406 Invalid 'Accept' header. object Generic HTTP error. idstring Machine readable error code. messagestring Human readable error details.