Information may be Out-of-Date
This page about deprecated software versions is only shown for reference purposes. Information on this page is not maintained and may no longer be valid.
This interface was initially introduced for IPCheck Server Monitor 5. For easy upgrades we have also implemented it for PRTG Network Monitor 7, but it should be considered deprecated for PRTG. Please use the PRTG API for new projects!
Documentation of the TEXTLIST interface of IPCheck Server Monitor and PRTG Network Monitor
Applies to PRTG Network Monitor V7.0.8 (or later) and IPCheck Server Monitor V5.0 (or later).
With the so-called TEXTLIST interface IPCheck Server Monitor and PRTG Network Monitor offer an easy and bandwidth-friendly way for other applications to access the monitoring status of servers and sensors for one account using a simple HTTP request.
This interface is used by the WinGUI of IPCheck to get the latest monitoring status. There are also demo PHP scripts that show how to access this data.
The URL of the TEXTLIST Interface
For HTTP you can access the data using a simple GET request to this URL (Note: if you use a port other than 80 for your IPCheck webserver please add the portnumber with a colon to the servername, e.g. server:8080):
or for SSL (recommended):
Documentation of the File Format
The reply to the TEXTLIST request is a simple text file. Each line of the file starts with a two character identifier (which declares the content of the line) and one or more parameters separated by a comma (",").
The following items can be found in the data:
|Ve||Version||1: Server's software version (see note 1)|
3: "Paused" if group is paused
|Sr||Server||1: Name |
3: Icon ID
4: "Paused" if server is paused
4: Status: "Up", "Down", "Paused", "Warning"
5: Result String or Comment
7: Last Scan
|Cl||Server Time||1: Date/Time value as a float (see note 2)|
|Ui||User's ID||1: User's ID (for building links into the web interface)|
|nv||New Version||1: Infotext (see note 3)|
|tt||Trial Info||1: "-1"=expired, "xx"=expires in X days, "" = not a Trial (see note 3)|
|Me||Message||1&2: Message Time (see note 2)|
3: Status (textfield or "0"=info, "1"=up, "2"=warning, "3"=down)
4: Text of the message
- Note 1: Check the server's software version to be compatible with your script
- Note 2: Times are float values in the timezone selected for the associated user account. The integral part is the number of days that have passed since 12/30/1899. The fractional part is fraction of a 24 hour day that has elapsed. e.g. "35065,5" stands for Jan 1st 1996 at noon
- Note 3: "tt" and "nv" only show up in IPCheck if necessary
- Note 4: Future versions of this interface may add new identifier codes as well as additional parameters to each line, your script should ignore these additional values