PRTG Manual: Application Programming Interface (API) Definition

The PRTG Application Programming Interface (API) enables you to access monitoring data and manipulate objects using HTTP requests, run your own written sensors and notifications, and implement Mini Probes.

Detailed HTTP API Documentation

An interactive documentation of the API is integrated into your PRTG installation: Login to the web interface and select Setup | PRTG API from the main menu.

PRTG API Documentation
PRTG API Documentation

In different tabs, the documentation provides information about:

  • HTTP API: Access monitoring data and manipulate monitoring objects using HTTP requests. This tab includes an interactive query builder that you can use to test your queries. You can find more details about accessing monitoring data and manipulating objects on the tabs Live Data, Live Graphs, Historic Data, and Object Manipulation.
  • Custom Sensors: Create your own sensors for customized monitoring. See also this Knowledge Base article: How can I share my self-written PRTG script/program with other PRTG users?
  • Custom Notifications: Create your own notifications to send alarms to external systems.

icon-prtg-on-premisesMini Probe API: Create your own small probes for PRTG on premises to get monitoring data from any platform. For sample usages of the Mini Probe interface, see this Knowledge Base article: Where can I find PRTG Mini Probes which are ready to use?

The documentation that comes with your PRTG installation fits exactly the PRTG version you are using.

More

Knowledge Base: How can I share my self-written PRTG script/program with other PRTG users?

Knowledge Base: Where can I find PRTG Mini Probes which are ready to use?

 

Advanced Topics