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.
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.
'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.'
The field name to sort the result list. Supported fields vary from object to object. Defaults to certain field depending on the object type.
Whether the sorting is applied descending or ascending. Defaults to certain field depending on the object type.
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.
Active Appliances stats.
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.
The field name used to sort the list.
Whether the sorting is applied descending or ascending.
The queries applied to the list.
The total readable count of entities. Not influenced by the query.
The filters applied to the list.
The field name the filter is applied to.
The value used for comparison.
The number of active Appliances with the Controller role enabled.
The number of active Appliances with the Gateway role enabled.
The number of active Appliances in total.
The number of active Appliances with the LogServer role enabled.
The number of active Appliances with the LogForwarder role enabled.
The number of active Appliances with the Connector role enabled.
The number of active Appliances with the Portal role enabled.
An active Appliance status details.
ID of the Appliance.
Name of the Appliance.
Name of the Site for this Appliance.
Tags of the Appliance.
Whether the Appliance is reachable by the Controller or not. Deprecated as of 5.1. "status" field will be set to "offline" instead.
The Appliance build version.
State of the Appliance. For internal use.
The volume number in use.
Aggregated status of the Appliance.
Comma-separated list of functions enabled on this Appliance in short format.
Status of the role.
Optional details for extra information like error messages.
Whether the maintenance mode is active or not on this Controller.
Database size.
Status of the given role for an Appliance.
Status of the role.
Optional details for extra information like error messages.
Status of the given role for an Appliance.
Status of the role.
Optional details for extra information like error messages.
Status of the role.
Optional details for extra information like error messages.
Number of active sessions on the Gateway or Portal.
Status of the role.
Optional details for extra information like error messages.
Number of active sessions on the Gateway or Portal.
Status of the role.
Optional details for extra information like error messages.
Number of active sessions on the Gateway or Portal.
Status of the role.
Optional details for extra information like error messages.
Where the audit logs being sent to.
Number of sessions on Gateway, Portal or Connector.
Current CPU utilization % on the Appliance.
Current memory reserved % on the Appliance.
Current disk usage % on the Appliance.
Disk usage information.
Total disk space in bytes.
Used disk space in bytes.
Free disk space in bytes.
Current network utilization on the Appliance.
The name of the NIC that's most used.
Number of inbound packets dropped for the whole uptime.
Number of outbound packets dropped for the whole uptime.
The speed of the inbound network activity on the busiest NIC. The average is taken for the last 10 seconds.
The speed of the outbound network activity on the busiest NIC. The average is taken for the last 10 seconds.
IPs of the Appliance per NIC.
Upgrade Status if there is one going.
The Upgrade status
Optional details for the current Upgrade Status.
The name of the Appliance Customization if one is assigned to this Appliance.
Invalid 'Accept' header.
Generic HTTP error.
Machine readable error code.
Human readable error details.