Home

Welcome to PrtgAPI!

The PrtgAPI project provides a C#/PowerShell library for interfacing with PRTG Network Monitor.

At its core, PrtgAPI does two things

• Serializes API requests, then
• Deserializes their resulting responses!

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 five projects

• PrtgAPI
• PrtgAPI.PowerShell
• PrtgAPI.Tests.UnitTests
• PrtgAPI.Tests.IntegrationTests
• PrtgAPI.CodeGenerator

PrtgAPI and PrtgAPI.PowerShell contain the the core C# and PowerShell libraries respectively, while the UnitTests and IntegrationTests projects contain a variety of tests to validate the functionality of the project. PrtgAPI.CodeGenerator provides automatic code generation functionality used when developing PrtgAPI's external interfaces.

Clients are able to interface with PRTG via four types of requests

• Synchronous
• Asynchronous
• Stream
• Query

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