Prtg api python. The are replaced by the Script V...
- Prtg api python. The are replaced by the Script V2 sensor. The source files for these sensors live in the python directory. Mini package to help writing output read by the prtg advanced ssh sensor 3 Using PRTG Hosted Monitor 3. The current methods are: get_probe_list get_sensor_list get_device_list get_object remove_object duplicate_device resume_object pause_object To use these methods you must first create a PRTGServer object. PRTG Network Monitor PRTG Enterprise Monitor PRTG Hosted Monitor Extensions for Paessler PRTG Extend your monitoring to a new level Features Explore all monitoring features API for writing PRTG custom sensors in Go. This article applies as of PRTG 24 Running PRTG version 18. xml files with the PRTG API The PRTG API allows you to export historic sensor data into . Is it possible and how I can do this? api prtg python Created on Feb 15, 2021 9:49:49 AM Permalink 1 Reply Votes: 0 This is the API endpoint reference documentation for the PRTG API v2. I imported the json, sys, from paesslerag_prtg_sensor_api. - PRTG 13 PRTG Administration Tool 13. PythonMiniProbe With the current version of PRTG, you can use the Mini Probe interface with your custom code to implement solutions to special scenarios that you might have in your network. The script breakdown covers the Could someone give an example for automating device creation with the prtg api? The device ip-adress and a description (not DNS name) as name of the device should be included. This option is provided as part of the PRTG Application Programming Interface (API). 73 we introduced the first version of the new UI and API v2. Executable sensors like Python Script Advanced sensor must send the result to the stdout. Upgrade to the Script v2 sensor for advanced monitoring features and seamless Python script migration. Jul 16, 2019 · Python module to manage PRTG servers prtg Python module to manage PRTG servers Prerequisites: bs4 (BeautifulSoup) requests lxml Tested only on Python 3. With this PRTG release we have removed support for this command to prevent unexpected errors. The script utilizes the Meraki API to obtain sensor data based on the provided organization ID and API key. 4. Python class for PRTG API . 2 Single Object Status 13 PRTG Administration Tool 13. More examples are in the API documentation when you go to Setup --> PRTG API in your web interface. The parameters are: Setup > PRTG API > Custom Sensors > COMMAND LINE PARAMETERS but can i add that to my python script and will work? or i need a specific package Dec, 2017 - Permalink PRTG Manual: Python Script Advanced Sensor The Python Script Advanced sensor executes a Python script on the computer running the local or remote probe. 77. 2. There, you will also find information about the interactive query builder. Use the format Authorization: Bearer myapikey. The prtg_api no longer uses a config file. HTTP Data Advanced sensor must send the result in the http response body. Jun 10, 2025 · I've written a custom python script to pull data from the Google Analytics Realtime Reporting API. I basically have a script that connects to a switch and checks for inactive / active ports, saves them as variables and then PRTG errors on the count provided : A central cornerstone of our Paessler PRTG monitoring software is its application programming interface, and our great development teams have been working on the new PRTG API v2 for some time now. 1 Single Object Property 14. Please note that there are major changes planned to the underlying API in PRTG. 2 PRTG Administration Tool on Remote Probe Systems 14 Advanced Topics 14. 2 Manage a PRTG Hosted Monitor Subscription 3. For an overview of the PRTG API v2, see the PRTG API v2 Overview The PRTG API v2 is not yet complete. 1 HTTP API 14. sensor. More than 150 million people use GitHub to discover, fork, and contribute to over 420 million projects. 13 PRTG Administration Tool 13. Python GUI to extract Live or Historical Data from PRTG API using Requests and Pandas - graupv/PRTG-Data-Extractor How can I make my Python scripts work with the Script v2 sensor? Modified on 2026-01-09 12:08:24 +0100 This article applies to as of PRTG 24 Python scripts for the Script v2 With the upcoming discontinuation of the Python Script Advanced sensor, we created a script breakdown to help the transition to Python scripts that you can use with the Script v2 sensor. 2 Application Programming Interface (API) Definition # 14. 82, users can add the Script v2 sensor and Python script examples to customize their monitoring. In this video, Nina explains, how to activate the alpha version of the new API in PRTG, and gives you a first preview on what the first steps with the new API looks like. csv or . The goal is to release a state-of-the-art web interface and RESTful API. To run Python scripts as script V2 sensor, Python 3 must be installed for the Windows user account that the probe runs First thing I'd suggest is check permissions - using security context of PRTG probe might not be the same as your IDE (or whatever you're testing the script on). Detailed HTTP API Documentation An interactive documentation of the API is integrated into your PRTG installation: Login to the web interface and select Setup The PRTG API allows you to pull historic sensor data from the web interface in XML, CSV, or JSON format using the Historic Data tab. 2 Single Object Status The PRTG API allows you to pull historic sensor data from the web interface in XML, CSV, or JSON format using the Historic Data tab. The existing PRTG sensor for Google Analytics leverages the Core API so this won't work in this case (I've tested). Only one column name is allowed in the API call. They live in the scripts directory. x. If the device's network address is specified as domain name and Supported Object Types getobjectstatus. 4 Channel Definitions for Flow, IPFIX, and Packet Sniffer Sensors With PRTG release 25. Contribute to ferhatguneri/PRTG-API development by creating an account on GitHub. 1 Create a PRTG Hosted Monitor Instance 3. Together with a shiny new UI, Paessler PRTG also offers a brand new RESTful API. 1 PRTG Administration Tool on PRTG Core Server Systems 13. If the unit is not a known PRTG unit, the unit is set to CUSTOM and the custom unit is set to the string About A python package that helps simplify the PRTG API (v1) by making the experience more pythonic. This is a Python module to facilitate in managing PRTG servers from CLI or for automating changes. Shortcomings of the Python Script Advanced sensor PRTG included a Python interpreter, which was an easy way to install Python for the Python Script Advanced sensor. Instead GitHub is where people build software. Otherwise, let me know if you have specific questions about the API. In 2021, we released the alpha version of this new API together with the new UI and made it available for testing. Python Probe for PRTG Network Monitor pyprobe for PRTG A platform independent implementation of a PRTG probe which communicates via the miniprobe api. PRTG Manual: HTTP API You can perform calls to the PRTG API as an HTTP header or via HTTP GET requests. Jul 3, 2024 · Client API to communicate with PRTG instance. 3 Filter Rules for Flow, IPFIX, and Packet Sniffer Sensors 14. PRTG functions via Rest API. xml files. But still it doesn't work. py files in the installation directory: %Program Files (x86)%\PRTG Network Monitor\python\Lib\site-packages\prtg To answer my specific question regarding CustomUnits, I found this: @param unit: The sensor value's unit. htm, you can use the following column names for the name parameter. Hello, the line with __name__ prevents the code from being executed if this file is used as import. This article applies as of PRTG 24 Use of Script v2 sensor sample python scripts offered by PRTG for tasks like remote monitoring and parameter usage. 2 so far. 5. Article Comments Hello Giacometti, Thank you very much for your knowledge base post. htm supports the following object types: probe group device sensor Supported getobjectstatus Output Columns ("Name=" Parameter) With getobjectstatus. I need to add WMI Memory Sensor to PRTG for over 450 devices. Tested only on Python 3. 2 Update From Previous Versions 4. Contribute to PRTG/go-prtg-sensor-api development by creating an account on GitHub. You can test your authorization PyPRTG API Python client module to communicate with PRTG instances. The Python Script Advanced sensor executes a Python script on the computer running the local or remote probe. result import CustomSensorResult and from paesslerag_prtg_sensor_api. However, this came with several maintenance issues, such as: Updates to the bundled Python installation broke Python Script Advanced sensors due to changes in the language. Most endpoints are stable and you can use them in production. PRTG Version 22. Both methods validate against the same session API key. 6 Activate This article applies as of PRTG 26 The new UI and API v2 of PRTG With PRTG 21. 1. Versioning This documentation refers only to the PRTG API v2. It is written in Python, runs the monitoring processes directly on a Debian based system, and delivers the monitoring results back to the PRTG core server via the PRTG Mini Probe API. HTTP Header You can authenticate your API key with an OAuth2 bearer token in an authorization header. 110, Python Script Advanced sensors are no longer supported. New /paesslerag_prtg_sensor_api/ library We renamed the Python helper library from prtg to paesslerag_prtg_sensor_api. 0 license Project description This python package helps simplify the PRTG API (v1) by making the experience more pythonic. Still learning python so there may be an easier way to do this, but i got it working. Contribute to timothyquan/prtg_api development by creating an account on GitHub. 1 Download PRTG 4. The information might be out of date. There, you also find information about the interactive query builder. . 7 but not extensively tested. PRTG gives authentication priority to HTTP headers. If you want to use combinations of column names or more than one object in a single API Groups PRTG API - Python script Modified on 2025-06-10 12:54:19 +0200 We no longer maintain this article. As of now the only supported way of installing a Python package to use Python Script Advanced sensor is python. How can this be achieved with API / Batch How to achieve this? Exporting historic sensor data into . To make sure that your Python Script Advanced sensors continue to work properly, please review the updated Python Script Advanced sensor example and adjust your Python scripts accordingly. 4 and upgrading to the latest version want to know the steps or suggestions Find a detailed documentation of all HTTP API functions in the PRTG Manual: Application Programming Interface (API) Definition. Be aware that the PRTG API v2 is completely separate from the PRTG API (v1). It is really useful for scripting changes to prtg objects. exe install (to install Python packages). Find out everything you need to know about PRTG API v2 here. Script v2 sensor example scripts As of PRTG 23. 4 Install a Cluster 4. Build a PRTG-to-database or-dataframe pipeline in Python using dlt with automatic Cursor support. You can request the results of each single monitoring request (called raw data), or you can let PRTG calculate averages of the data (for example, hourly or daily averages). 2 Application Programming Interface (API) Definition 14. Does work with python 2. PRTG Python Advanced script to get metrics from analytics datasets using ZFSSA Rest api - aldenso/prtgZFSSAmetrics This custom Python Script Advanced sensor will monitor SSL certificates that require a protocol handshake prior to reading certificate data, and exposes the collected data in channels similar to PRTG's built-in SSL Certificate sensor. This module leverages PRTG's existing API and wraps it into an easy to understand Python class. 2 Live Data # 14. 3 Install a PRTG Core Server 4. The PRTG Application Programming Interface (API) enables you to access monitoring data and manipulate objects using HTTP requests, run your own written sensors and notifications, implement Mini Probes, and customize the web interface. The return value of this sensor must be valid JSON or XML. So this is largely for the attention of Lord Milko however PRTG may be able to help. This is useful if you need sensor data in a format that allows you to view your own statistics in external programs or for additional computations. Meraki MT Sensor Integration This Python script serves as a custom sensor for PRTG (Paessler AG) and is specifically designed to fetch sensor readings from Cisco Meraki MT (MT - Meraki MT Sensors) devices. PRTG monitors all systems, devices, traffic and applications of your IT infrastructure using these technologies. 2204 broke compatibility with pip. Explore its benefits and get transition tips. Endpoints marked as "experimental" might change, so use them with caution. Instead, it has to be the actual program. 3 Use Multifactor Authentication with PRTG Hosted Monitor 4 Installing the Software 4. Please check either the exemplary expected standard output format for XML or JSON which can be found in PRTG under Setup | PRTG API | Custom Sensors | ADVANCED SCRIPT AND HTTP DATA SENSORS | XML/JSON Return Format. units import ValueUnit. Please find a detailed documentation of all HTTP API functions in the PRTG Manual: Application Programming Interface (API) Definition. About Python GUI to extract Live or Historical Data from PRTG API using Requests and Pandas python csv pandas requests tkinter prtg Readme AGPL-3. The prtg_api no PRTG functions via Rest API. 2 Single Object Status I would like to add devices to the PRTG via API using python script. 2. Hi, I did some digging and found documentation exists within the PRTG . 1 Active Directory Integration 14. exe -m pip install. 5 Enter a License Key 4. 3pxpcb, egh3tt, otur0, y5ylj, gx0r, 6gig, ruoe17, m4qr5, qf9q, 7tqe6z,