Home

Welcome to PrtgAPI!

The PrtgAPI project provides a .NET library exposing C# and PowerShell interfaces for

• Serializion of requests send to PRTG Servers
• Deserializion of responses received from PRTG Servers

C:\> Get-Sensor ping

Name                Id      Device      Group           Probe            Status
----                --      ------      -----           -----            ------
PING                2010    dc1         Servers         Local Probe      Up
Ping                2011    dc2         Servers         Local Probe      Down
Ping                2012    exch1       Servers         Remote Probe     DownAcknowledged

PrtgAPI features complete XmlDoc/Get-Help documentation. For instructions on installing PrtgAPI see Installation. To get started using PrtgAPI, see Getting Started

Project Overview

The PrtgAPI repo consists of three projects

• PrtgAPI
• PrtgAPI.Tests.UnitTests
• PrtgAPI.Tests.IntegrationTests

PrtgAPI contains the core library, while the UnitTests and IntegrationTests projects contain a variety of tests to validate the functionality of the library.

Clients are able to extract data from PRTG via three types of requests

• Synchronous
• Asynchronous
• Stream

For more information on each type, please see the Requests page.