View System Health Events with REST API (version 1.0)

Use SYSTEM_HEALTH to return the raw list of your deployment health events that occurred recently.

The SYSTEM_HEALTH REST API supplies the Aternity components status as displayed in the System Health dashboard. Only users with system permissions who are allowed to see the System Health dashboard, can see and use this API.

For example, you can see what system components are malfunctioning (Aggregation Server displays status Failed).

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmith

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). The <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.


To access this API from a browser, Excel or Power BI (learn more), enter https://<server name>

Supported Parameters

You can view the data by entering the URL into Excel, into a browser, or into or any OData compatible application such as Power BI.

You can add parameters to the URL to filter the returned data, by adding a question mark (?) followed by a parameter and value, such as .../API_NAME?$filter=(USERNAME eq ''), or several parameter-value pairs each separated by an ampersand (&), like .../API_NAME?$format=xml&$top=5.

Parameter Description

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3


Use $filter to insert conditions that narrow down the data, to return only entries where those conditions are true..

Create conditions with operators: and, or, eq (equals) gt (greater than), ge (greater than or equal), lt (less than), le (less than or equal), ge (greater than or equal to), ne (not equal to), le (less than or equal to), not and contains. Use operators with parentheses to group conditions logically: .../API_NAME?$filter=(COLUMN1 eq 'value1' or COL2 neq 'val2') and (COL3 gt number) and not (COL4 eq 'val4' or contains(COL5,'val5'))


Use $format to force the returned data to be either in XML or JSON format. This is only useful for testing the raw data in a web browser. For example: .../API_NAME?$format=xml


Use $orderby to sort the returned data according to the value you choose. For example, .../API_NAME?$orderby=LOCATION


Use $top (lower case only) when you are initially testing the response of the API by returning the first few entries.

For example, to return the first five entries (not sorted), use: ...API_NAME?$top=5

$search is NOT supported.

Do not use $search in Aternity's REST APIs.


Each entry from SYSTEM_HEALTH represents a single Aternity component, and provides details about that component functioning.


Once you run this API, you see the current components that are also displayed on the System Health dashboard and their status, uptime (in days), component version, IP address where the component installed, time zone and the last time when the component reported to Aternity.

If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements.

The API returns two types of columns: Attributes (or dimensions) which are the properties of an entry, and Measurements which are the dynamic measured values. A single API row can display either a single measurement, or a weighted average of several entries grouped together. If you use $select to display several attributes, and all those attributes are identical, it groups them into a single entry.

The returned columns are:

Component name,Component Status,Component Status Details,Component Uptime In days,Component Version,Device_IP_Address,Device_Name,Device Timezone,Time_Last_Reporting