This article applies to PRTG Network Monitor 7.2

Introduction to the PRTG API Interface

Users can customize and extend the functionality of PRTG Network Monitor using the following options:

• HTTP API: Access monitoring data and manipulate monitoring objects using HTTP requests
• Custom Sensors: Create your own sensors for customized monitoring
• Custom Notifications: Create your own notifications to send alarms to external systems
• Website Styling: Customize the look and feel by adding your own CSS statements

An Important Note About Technical Support Regarding API Features

Working with PRTG's API can quickly become a technical challenge and it is no everyday tasks. In most cases the knowledge of an experienced software developer or web developer is required to work with the API. All API features described on this page as well as their usages are not covered by Paessler's usual next-business-day support. So please understand that it may take a few days to receive an answer to inquiries about API features from Paessler Support. In general we can not provide support for web design issues involving your own CSS and HTML.

HTTP API

This section will give you a brief overview over the functionalities of the API interface. For detailed instructions see the API documentation (section "Detailed HTTP API Documentation" below).

The PRTG HTTP API offers the following functionality:

• Authentication, error handling and optional encryption
• Functions for getting live object and status data as well as live graphs
• Functions for getting historic sensor data and graphs
• Functions for manipulating objects (e.g. edit, add, delete)

You can use it via simple HTTP GET requests (either HTTP or HTTPS). Sample Call:

http://yourserver/api/table.xml?content=sensortree

Detailed HTTP API Documentation

Please find a detailed documentation of all HTTP API functions in your PRTG Network Monitor installation. Login into the web interface and then select "Help | PRTG RESTful API" from the main menu. There, you will also find an interactive query builder.

You can also have a look at Paessler's PRTG demo installation's API documentation at https://prtg.paessler.com/api.htm?username=demo&password=demodemo

Please Note: Only the documentation that comes with your PRTG installation fits exactly the PRTG version you are running.

Custom Sensors

Custom sensors allow a number of monitoring tasks that go far beyond the standard sensor set to be performed. Apart from parameterized versions of SNMP, packet sniffer and NetFlow sensors you can create your own sensors using WQL (WMI Query Language) and by compiling an EXE file, using any Windows software development tool.

More details about Custom sensors:

• Interface Definition for Custom EXE Sensors

• Ready-to-use custom sensors at Google Code

• Tag set "custom-sensor" in this Knowledge Base

Note: With PRTG custom sensors, you can use placeholders.

Custom Notifications

Custom notifications allow you to run any script or program as a notification. Connected with a trigger connected with a sensor's settings, you can initiate a desired action - even far beyond a notification itself. This is a powerful tool to react to specific situations in your network.

Among the possibilities are the following scenarios:

• Reboot a computer with a WMI call
• Script text message notifications with Windows Powershell (using an SMS text message provider service)
• Send text message notifications via a modem or a mobile phone (using third-party software)
• Send messages from PRTG directly to Twitter
• How can I execute a batch file as notification?

Note: With PRTG notifications, you can use placeholders.

Website Styling

PRTG users can use their own logos and/or corporate colors inside the AJAX GUI and HTML GUI web interface by adding their own HTML and CSS code to PRTG's website.

Among the possibilities are:

• Customize the PRTG web interface's login screen
• Re-brand and customize the PRTG web interface using CSS