Get System Health as RSS (REST)

Overview

As of Princeton Server version 3.7, the data that is shown on your server’s System Health page is exposed via an RSS feed. This allows you to monitor your system’s health more easily from other systems, perhaps via your favorite RSS Reader or programmatically using an HTTP, REST, or RSS API.

Request URL

The URL of the feed can be auto-discovered by browsing to your System Health page, http://myserver/system_health, and clicking the RSS icon in your Web browser. The RSS icon location differs between browsers, but it is usually in or near the Address Bar (at the top). Clicking the RSS icon will bring you to the URL of the feed:

http://myserver/system_health/rss?api_key=f1815f1f2011e32b6309

api_key is generated on the users tab which is accessible from the config tab. This is required as of version 3.16.

Subscribing

After clicking the RSS icon, most modern Web browsers will show a preview of the actual feed data, and give you some options to subscribe to the feed. Subscribing to the feed will, in most cases, launch your default RSS Reader application and add the feed to it. On a default system, usually your email application (Outlook, Thunderbird, Mail, etc.) is configured as the default RSS Reader. There are a number of third-party RSS Readers and Aggregators that can be installed into your system or exist on the Web as browser-based services. It is important to understand that Web-based RSS Readers will not be able to access the RSS feeds on your Princeton Server because your server is located on your local network that is not exposed to the Internet.

Code Examples

For code examples of programmatically consuming an RSS feed, please refer to our documentation about the Channel Schedule RSS Feed.

Returns

Success

Here is an example snippet from the System Health RSS feed’s XML response:

< ?xml version="1.0" encoding="UTF-8"?>

http://myserver/system_health
Fri, 23 Apr 2010 20:28:33 GMT
    System health for TelVue Princeton server, myserver.

Fri, 23 Apr 2010 19:39:11 GMT

            <table width="720" cellspacing="0" cellpadding="4" style="margin-left: 20px; border-bottom: 1px solid #ccc;">
              <thead>
                <tr style="background: #dfe9ee; border-top: 1px solid #ccc; border-bottom: 1px solid #ccc;">
                  <th width="80" align="left">Status</th>
                  <th width="190" align="left">Message</th>
                  <th width="130" align="left">Info</th>
                  <th width="160" nowrap="nowrap" align="left">Last Check</th>
                  <th width="160" nowrap="nowrap" align="left">Next Check</th>
                </tr>
              </thead>
              <tbody>
                <tr>
                  <td width="80" valign="top">OK</td>
                  <td width="190" valign="top">OK</td>
                  <td width="130" valign="top"></td>
                  <td width="160" nowrap="nowrap" valign="top">04-23-2010, 15:39:11</td>
                  <td width="160" nowrap="nowrap" valign="top">04-23-2010, 23:39:11</td>
                </tr>
              </tbody>
            </table>

OK
OK
Fri, 23 Apr 2010 19:39:11 GMT
Sat, 24 Apr 2010 03:39:11 GMT

     ...

The block of encoded HTML inside the description tag is a nicely formatted version of the data for RSS Readers that support HTML embedded within feeds (most readers).

History

Introduced
Princeton Server 3.7.0
in HC API System ManagementHC APIs

Related Articles