
= Realtime Console Data

The Realtime Console (RTC) calculates the availability for monitored services.
Data provided from the RTC is available to the REST API.

== GETs (Reading Data)

[caption=]
.Realtime Console Data API GET functions
[cols="2,3"]
|===
| Resource  | Description

| /availability/categories/\{category}
| Get all nodes and availability data from a given SLA category filter (for example, Web Servers (Web+Servers)).

| /availability/categories/\{category}/nodes
| Get node availability data for each node of a given SLA category filter.

| /availability/categories/\{category}/nodes/\{nodeid}
| Get detailed service availability for a given node in a given SLA category filter.

| /availability/nodes/\{nodeid}
| Get detailed availability for all services on a given node.
|===

IMPORTANT: The categories referenced above are RTC categories defined in `$OPENNMS_HOME/etc/categories.xml`, not tags assigned to nodes.

== Example

[source, bash]
----
curl -u demo:demo http://demo.opennms.org/opennms/rest/availability/categories/Web+Servers
curl -u demo:demo http://demo.opennms.org/opennms/rest/availability/categories/Web+Servers/nodes
curl -u demo:demo http://demo.opennms.org/opennms/rest/availability/categories/Web+Servers/nodes/31
curl -u demo:demo http://demo.opennms.org/opennms/rest/availability/nodes/31
----
