<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Live Data

You can access live data and live status data of objects using the PRTG API.

In this section:

Getting PRTG System Status

You can also get the PRTG system status such as the number of alarms or messages using the following API calls.

Examples

Live system status in the Extensible Markup Language (XML) format:

/api/getstatus.xml?id=0

Live system status in the JavaScript Object Notation (JSON) format:

/api/getstatus.htm?id=0

All sensors in use in the JSON format:

/api/sensortypesinuse.json

Number of all sensor states:

/api/gettreenodestats.xml

Getting PRTG Health Status

You can also get the overall PRTG system health status such as probe connection status and if login is possible using the following API calls:

Examples

Live overall system status of PRTG in the JSON format:

/api/healthstatus.json

Live overall system status of PRTG Hosted Monitor in the JSON format:

/api/healthstatus.json&mode=hosted

Getting PRTG Health Data

You can also get the PRTG health data such as system CPU used (%), system memory used (%), disk space used (%), disk space used (GB), health (%), total number of probes, disconnected probes, total sensors, and sensor in the Unknown status using the following API calls:

Example

Live health data of PRTG in the JSON format using maxage:

/api/health.json&maxage=age

maxage is the age in seconds for data to be considered "old". For example, if data is older than 4 minutes and maxage=120, the data will be refreshed and then sent to the client.

Live health data of PRTG in the JSON format using refreshnow:

/api/health.json&refreshnow=1/anything_else

If refreshnow=1, the data will be refreshed before the API call is returned. Also, if refreshnow=1 is present in the API call, maxage will not be considered.

KNOWLEDGE BASE

How can I use the PRTG Application Programming Interface (API)?

https://kb.paessler.com/en/topic/593