PRTG Manual: Live Data
You can access live data and live status data of objects using the PRTG API.
Getting Single Object Property
You can get the properties or settings of a single object such as name, hostname, or URL using the PRTG API.
See section Single Object Property for more information.
You can get the status of a single object such as last value or downtime using the PRTG APII.
See section Single Object Status for more information.
Getting Multiple Object Property or Status
You can get the property or status of multiple objects and use sorting and advanced filtering using the PRTG API.
See section Multiple Object Property or Status for more information.
You can get system information from the system information tables using the PRTG API.
See section System Information for more information.
You can also get the PRTG system status such as the number of alarms or messages using the following API calls.
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 |
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:
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 |
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:
Live health data of PRTG in the JSON format using maxage: /api/health.json&maxage=age
Live health data of PRTG in the JSON format using refreshnow: /api/health.json&refreshnow=1/anything_else
|
Knowledge Base
How can I use the PRTG Application Programming Interface (API)?