The following is the API related to the top-level basic REDHAWK information.

HTTP GET

/ redhawk / rest

No REST structures are returned at this URL, however a GET will result in a confirmation message that the server is online. Instead this address is how one accesses two different websockets of data: REDHAWK Domain events, and Event Channels for specific domains.

WEBSOCKET READ

/ redhawk / rest / redhawk

{
    "domains": [ /* List of Domain Names */ ],
    "added":   [ /* Those Added */ ],
    "removed": [ /* Those Removed */]
}

This stream continually polls at roughly once per second on the server side so that multiple clients remain synchronized without bombarding the server with HTTP GET requests. So rather than having to poll /redhawk/rest/domains to keep track of changes manually, this socket will instead push not only the list of known Domains but also added and removed lists for simple top-level management of which REDHAWK Domains are presently online.