C#/PowerShell interface for interacting with the PRTG HTTP API

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PrtgAPI -RequiredVersion 0.7.1

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More




(c) 2015 lordmilko. All rights reserved.



Prtg Sensor Device Group Probe Channel Notification Action Trigger Remove Pause Resume Check Acknowledge PowerShell Setting Property


Disable-PrtgProgress Enable-PrtgProgress Copy-Sensor Copy-Group Copy-Device Get-SensorHistory Move-Object Set-ObjectPosition Test-ErrorStatus Start-SortPrtgObject Open-PrtgObject Start-AutoDiscovery New-SensorFactoryDefinition Add-NotificationTrigger Set-NotificationTrigger Edit-NotificationTriggerProperty Get-NotificationAction Get-NotificationTrigger Get-ModificationHistory New-NotificationTriggerParameter Remove-NotificationTrigger Set-ObjectProperty Confirm-Sensor Get-Channel Get-Group Get-Probe Get-ObjectProperty Get-PrtgClient Get-SensorTotals Update-Object Suspend-Object Rename-Object Resume-Object Set-ChannelProperty Remove-Object Get-Device Connect-PrtgServer Disconnect-PrtgServer Get-Sensor New-SearchFilter


New-Credential Connect-GoPrtgServer Get-GoPrtgServer Install-GoPrtgServer Set-GoPrtgAlias Uninstall-GoPrtgServer Update-GoPrtgCredential


This module has no dependencies.

Release Notes

-PS: Improved error message when attempting to modify a GoPrtg server you are connected to under a different username
-An exception will now be thrown if you attempt to create a TriggerParameters object from an inherited NotificationTrigger object

-PS: Fixed a bug wherein Edit-NotificationTriggerProperty would fail to parse enum values

Breaking Changes
-C#: Implemented new trigger parameter constructors for creating trigger parameters from existing NotificationTrigger objects
-C#: Removed redundant ModifyAction parameter from existing trigger parameter constructors taking NotificationTrigger objects. This constructor is now solely for creating brand new notification triggers


PrtgAPI is a C#/PowerShell library that abstracts away the complexity of interfacing with the PRTG HTTP API.

PrtgAPI implements a collection of methods and enumerations that help create and execute the varying HTTP GET requests required to interface with PRTG. All responses from PRTG are automatically deserialized by PrtgAPI and formatted appropriately when output to the pipeline (when using PowerShell)

All cmdlets in PrtgAPI support some level of piping, allowing you to directly chain multiple cmdlets together, further filtering search results as you go.

PrtgAPI supports a number of undocumented features, including manipulating notification triggers, and viewing and editing channel properties (error limits, etc).

PrtgAPI includes full Cmdlet Comment/XmlDoc documentation. Detailed information on any cmdlet can be found within PowerShell by running Get-Help <cmdlet> or Get-Help <cmdlet> -Full

For examples and usage scenarios, please see the Project Site.

Version History

Version Downloads Last updated
0.9.5 1,109 1/13/2019
0.9.4 114 1/3/2019
0.9.3 43,299 11/20/2018
0.9.2 409 11/1/2018
0.9.1 252 10/3/2018
0.9.0 192 8/27/2018
0.8.6 586 5/4/2018
0.8.5 34 4/23/2018
0.8.4 5 4/23/2018
0.8.3 46 4/2/2018
0.8.2 5 3/30/2018
0.8.1 56 3/11/2018
0.8.0 82 2/23/2018
0.7.3 149 11/20/2017
0.7.2 28 11/13/2017
0.7.1 (current version) 30 10/15/2017
0.7.0 13 10/6/2017
0.6.10 46 8/2/2017
0.6.9 72 4/24/2017
0.6.8 25 4/19/2017
0.6.7 12 4/11/2017
0.6.6 5 4/10/2017
0.6.5 5 4/10/2017
0.6.4 13 3/25/2017
0.6.3 5 3/22/2017
0.6.2 6 3/19/2017
0.6.1 7 3/14/2017
Show less