If you are accessing the API inside your secure LAN, you can simply use HTTP. Most data that you can request from the PRTG API is available in data tables in the Extensible Markup Language (XML) format, the JavaScript Object Notation (JSON) format, and the comma-separated values (CSV) format (using the XML format is recommended). This includes all Paused states ('paused by user', 'paused by dependency, 'paused by schedule', etc.). For notifications that are paused by schedule, it also displays the end of the schedule. Config is in prtg.conf in \local only! Created on Apr 5, 2013 6:36:41 PM by It is also given a content-type of HTML and not XML (like it is). For content=messages and content=tickets only. You only get the object with the specified ID and all child objects below it. The API call by default only returns 500 devices. For probes: probe status (0=Disconnected, 1=Unauthorized, 2=Connected, 3=Banned, 4=Init), ID of the parent object or ID of a ticket, Subobjects are folded up (true) or down (false), For tickets: user (or user group) to which a ticket is assigned read it since last change, Number of groups or devices in the probe or group, Text of the ticket that was added with the last edit, Number of channels with an ID greater than or equal to 0, Display name, class, and caption from the system table, User and domain pair from the system table, Display name, creation date, and process id from the system table, Display name, state, and start mode from the system table, Display name and version pair from the system table. - covenanttechnologysolutions/node-PRTG TOUTES LES FONCTIONNALITÉS . &filter_type=ping. For more information on possible raw message status values returned by table-based API calls, see the Knowledge Base: Is there a list of log status values for the PRTG API? PRTG is one of my favorite monitoring tools, as not only is it great out of the box, but it also has great synergy with PowerShell. The fractional part of a value is a fraction of a 24-hour day that has elapsed. However, you should use raw query mode and reference the PRTG api directly. The following API calls retrieve all information from a system information category table. ●3 , because then it is expanded for all visible channels/toplist columns. ) You can find it in the PRTG web interface under Setup | PRTG API, section Live Data. /api/table.xml?content=devices&output=csv&columns=objid,probe,group,device,host, Created on Apr 5, 2013 12:59:05 PM by &filter_status=5&filter_status=4&filter_status=10&filter_status=13&filter_status=14&sortby=priority, /api/table.xml?content=sensors&columns=objid,sensor,lastvalue,status,message&sortby=lastvalue I created a local "service" account in PRTG to provide access to the HTTP API to pull device info for our Asset Management (AM) team to access. XML data from the PRTG API contains the fields that you requested in the columns parameter. Any column name used in the columns parameter. I get a incomplete list of devices. Numbers are 5-minute averages for the last 24 hours (must be scaled to the maximum of the series). Only include sensors with a specific status. Please log in or register to enter your reply. The typical use case is to periodically retrieve sensor status and values. Do not accept version numbers older (smaller) than this one. XML data from the PRTG API contains the fields that you have requested in the columns parameter. For stored reports: the name of the report file. ●4. An exclamation mark (!) answering questions! Devices 856. which is also different from what the api qry returns. Pastebin.com is the number one paste tool since 2002. Most XML replies from the PRTG API contain a field that contains the program version and buildnumber of the server's PRTG installation. You should display a warning to the user (or stop processing) if the version … For alerts created by PRTG. Using multiple filter_xyz fields performs a logical OR.        Created.
18.3.43.1360 The problem I am having is that the result from the API is attached as an attachment to the response, not in the body. Mathias Hengl [Paessler Support]. List of all tags (for tickets: tags for the related object). PRTG alerts you when it discovers warnings or unusual metrics. PRTG Tools Family [prtgtoolsfamily.com] Created on Apr 5, 2013 6:06:40 PM by Add an ID parameter (for example, id=1) to the API URL to select a subset of items for the data table, for example, to reduce the amount of data transferred for each data table API call. The URLs consist of a path to the API function and some parameters. Working with the PRTG API can quickly become a technical challenge and it is no everyday task. or to automatically display volumes and speed. When I go to "PRTG Host"/status.htm?tabid=1 I get the following : Database Objects Multiple filters are not available for tickets. The Get-PrtgTableData cmdlet can return data of various different content types using the specified parent object, as well as specify the return columns or filtering options. filter_drel, Introducing the PRTG Network Monitor API API: Get table of device history by sensor Regards, Lydia. Node.js module for interacting with the PRTG API. As it is … Here's my prtg.conf (minus the IP and the PASS), in the local directory.-bash-4.2$ cat prtg.conf [default] server= protocol=[HTTP|HTTPS] user=prtgadmin password= Inventory | prtgws api="table" columns="objid,type,group,device,sensor,status,message,lastvalue,priority,favorite" api call on prtg http api filter_xyz where xyz is any column name used in the columns parameter Some table types require an ID. Find out how you can PRTG Manual: HTTP API All calls to the PRTG HTTP API are performed by HTTP GET requests. Log entries of the last 7 days for object id 2003: /api/table.xml?content=messages&id=2003&start=0&filter_drel=7days&columns= The input formats generally coincide with the Live Data demo from the PRTG API documentation, but there are some content types that the cmdlet does not yet support, such as "sensortree". A hierarchical list of all groups, devices, and sensors with their status information: /api/table.xml?content=sensors&columns=objid,group,device,sensor,status,message,lastvalue,priority,favorite, /api/table.xml?content=messages&columns=objid,datetime,parent,type,name,status,message. In most cases the knowledge of an experienced software developer or web developer is required to work with the API. In most cases, numerical values will be included twice: One field contains the value in human-readable format and an additional "RAW" field contains the value as a number, which is better suited for further processing and calculations. and filter_dend. This includes tags from the object itself plus tags that are inherited from parent objects. Most XML replies from the PRTG API contain a field that contains the program version and buildnumber of the server's PRTG installation. (with their status and downtime information): /api/table.xml?content=sensors&columns=objid,downtimesince,device,sensor,lastvalue,status,message,priority, &filter_status=5&filter_status=4&filter_status=10&filter_status=13&filter_status=14&sortby=priority, /api/table.xml?content=sensors&columns=objid,sensor,lastvalue,status,message&sortby=lastvalue, /api/table.xml?content=messages&id=2003&start=0&filter_drel=7days&columns=, Name of the associated device and the associated group separated by a forward slash (, or the current interval setting of the object, Complete object hierarchy with names of associated device, group, and probe separated by a forward slash (, ). When used with channels, you have to use lastvalue_ to automatically display volumes and speed. For added security, your PassHash is then used for all future PRTG Requests made during the life of your program. If more than one group is in the object hierarchy, these are displayed with '..'. Values not equal/above/below: use [email protected](value), [email protected](value), [email protected](value), Sort the data. This modular input polls and retrieves data from Paessler PRTG Network Monitor. Post Reply Preview Exit Preview. prtg_api(host,user,passhash,protocol='https',port='443',rootid=0) Upon initialisation the entire device tree is downloaded and each probe, group, device, sensor and channel is provided as a modifiable object. You can now use the URL as it is or change various parameters to suit your needs.        Created. All API features described on this page as well as their usage are not covered by Paessler's usual next-business-day support. PRTG has fairly detailed API documentation, but doing the above turned out to be surprisingly challenging, so i'm detailing it here in case it should help someone else in the future. There are various options to further filter and to sort the data for each data table API call: Only include records younger than this setting. Sensor coverage of the time span in a value table. For columns with date/time value, the RAW value is defined as follows: The integral part of a value is the number of days that have passed since Dec 30th, 1899. You should display a warning to the user (or stop processing) if the version … PRTG Passhash: API Passhash obtained from the account settings. In insecure environments (for example, when accessing your PRTG server across the internet), you should use HTTPS requests to make sure that your parameters … if the sensor tree object is marked as favorite, Application Programming Interface (API) Definition, PRTG Enterprise Monitor Quick Start Guide (PDF), The monitoring solution for all areas of IT. PRTG URL: The desired URL to use to visit your PRTG page. If you want to use combinations of column names or more than one object in a single API call, use a table API … So please understand that it may take a few days to … In the spotlight with this post: LordMilko, a PRTG user who developed PrtgAPI, a C#/PowerShell library for managing PRTG. For content=tickets, you can use the special filter terms This is the PRTG User Spotlight, where we give the podium to our users to show us what they've done with PRTG, or let them share their guidance and knowledge. From the main object (called prtg in example) you can access all objects in the tree using the prtg.allprobes, prtg.allgroups, prtg.alldevices and prtg.allsensors attributes. I am integrating the API from our monitoring software (PRTG) into our website and attempting to use a function that generates a list of data in XML format. You cannot use columns to filter objects like messages or tickets, for example. The API function /api/table.xml is used to access data in tables.        97.7583 You have the easiest start if you use the XML table query builder or click , which most data tables have in the PRTG web interface. Cumulated downtime of the sensor (displayed as percentage of uptime+downtime), Cumulated downtime of the sensor (in minutes/hours), Elapsed time since last Up status of the sensor, Cumulated uptime of the sensor (displayed as percentage of uptime+downtime), Cumulated uptime of the sensor (in minutes/hours), Elapsed time since the last Down status of the sensor, Sum of cumulated uptime and downtime of the sensor, Time stamp when accumulation of uptimes/downtimes began, Effective interval setting for the sensor, Time stamp of the most recent Up status of the sensor, Time stamp of the most recent Down status of the sensor, Name of the associated device and the associated group separated by a forward slash (/), Number of each trigger type defined for the object, Either Inherited or the current interval setting of the object, Access rights of the current user for the sensor tree object. The output is stored in the Additional information field of the event. PRTG only counts the sensor itself or sensors below the object in the hierarchy.        98 % 300.000 administrators have chosen PRTG to monitor their network. if the sensor tree object is marked as favorite. XML data from the PRTG API contains the fields that you requested in the columns parameter. In the PRTG KB there is some more examples of getting started with the Grafana PRTG plugin. The data table only contains information for this object ID and its child objects. Number of sensors in the Down (Acknowledged) status, Number of sensors in the Down (Partial) status. O.k., that only gives me more info (additional fields) on the devices that are listed from my attached api call, but this is not a complete list of devices. The typical use … Use this section to map Opsgenie actions to a PRTG action when the source of the alert is PRTG (i.e When the alert is created by PRTG.) To find the fractional number of days between two dates, subtract the two values. Monitor and network monitoring in general. For log messages/tickets: the name of the related object. For further security, you are able to immediately pass your passhash to PrtgClient instead of using your password. Filter the data. Here are some examples of date/time RAW values and their corresponding dates and times: The following parameters are common to all data table API calls: Select the objects that you want to have in your table. (0) (Samples: sortby=name, sortby=lastvalue, sortby=-lastvalue, sortby=uptime). You can use the following column names for the columns parameter (separated by comma, for example, columns=objid,name,type). Note: This documentation refers to the PRTG System Administrator user accessing the Ajax interface on a master node. (13,183) Groups 150 Find out how you can reduce cost, increase QoS and ease planning, as well. Since 1997, our mission has been to empower technical teams to manage their infrastructure, ensuring maximum productivity. Created on Apr 4, 2013 9:09:39 PM by Top Tags. You can access live data and live status data of multiple objects using the PRTG API. How can I use the PRTG Application Programming Interface (API)? Using multiple filter_tag fields performs a logical OR. Only one column name is allowed in the API call. Log tables with content=messages are always sorted by descending date. And that’s exactly what we will try to achieve. True/false depending on whether an object is set to paused by a user (for tickets: related object). For sensor tree objects: status of the object (0=None, 1=Unknown, 2=Scanning, 3=Up, 4=Warning, 5=Down, 6=No Probe, 7=Paused by User, 8=Paused by Dependency, 9=Paused by Schedule, 10=Unusual, 11=Not Licensed, 12=Paused Until, 13=Down Acknowledged, 14=Down Partial), For messages: category of the log message, For tickets: status of ticket (open, resolved, closed), Detailed message of the sensor tree object (for example, last error of the sensor) or the history entry, log entry, ticket subject, Priority setting of the sensor tree object or the priority of the log entry/ticket, tickets (not supported: schedule, notification, user), Last sensor result value or channel values. (0) The example URLs only show the XML URLs. Numerical data for the minigraphs. Pastebin is a website where you can store text online for a set period of time. When a PrtgClient is created, it will immediately attempt to retrieve your account's passhash (an alternative to using a password) from your PRTG Server. I cant seem to get JAX-RS to pull the XML out of the attached file and ideally pass to JAXB for marshalling. Probes 5 Number of sensors in the Paused status. Filtering using columns is only possible for tree objects. Created.
18.3.43.1360, Created. Columns. This knowledgebase contains questions and answers about PRTG Network To retrieve this information via the PRTG API, you need to provide. Number of sensors in an undefined status, like. Specify which columns to be returned by the connector. In most cases, numerical values are included twice: One field contains the value in human-readable format and an additional _RAW field contains the value as a number, which is better suited for further processing and calculations. IP Fabric API sensors library in PRTG. I am trying to parse the response from the PRTG HTTP REST API using JAX-RS (RESTEasy to be exact). Pastebin is a website where you can store text online for a set period of time. You are invited to get involved by asking and answering questions! You get system information of the object with the specified ID. This knowledgebase contains questions and answers about PRTG Network Monitor and network monitoring in general. Name of the parent object of the associated object of a log message, Time stamp or time span of the object (for tickets: last modification), For sensor tree objects: Name of the associated schedule, Time stamp of the last generation of a report, Time stamp of the next generation of a report. You are invited to get involved by asking and PrtgAPI can be used to add even more flexibility to PRTG. I've pulled the passhash from the service account and included it in the URL as outlined in the PRTG API manual example: If you omit the ID parameter or if it has the value zero (0), all available objects are used. Here are some samples for filtered API calls: All sensors that are not in the Up status (with their status and downtime information): /api/table.xml?content=sensors&columns=objid,downtimesince,device,sensor,lastvalue,status,message,priority Map different Opsgenie actions to different PRTG action. 18.3.43.1360, RAW columns are surrounded by double quotes (, Filtering using columns is only possible for tree objects. ●1, you can use the following API-Call /api/table.xml?content=devices&output=xml&columns=objid,probe,group,device,host filter_status In PRTG, we will create a variety of new REST sensors, that will read data from IP Fabric’s API. You only get tickets or logfile entries that are related to the object with the specified ID or any child objects below it. Contribute to AndrewG-1234/PRTG development by creating an account on GitHub. Performance impact of the sensor (1=Very Low, 2=Low, 3=Medium, 4=High, 5=Very High). For. Your client must look at this version number and compare it to the version number that was used to develop the client. Using multiple filter_status fields performs a logical OR. You get a list of stored .pdf files of the report selected by the ID. Comma-separated list of columns per record, see Supported Output Columns ("columns=" Parameter), xmltable: an HTML table in the XML format, Start with this entry number (can be used with "count" to request the data page by page). ●1. If more than one group is in the object hierarchy, these are displayed with '. You get the history of the ticket selected by the ID. You get the data values (or channels) of the sensor with the specified ID. When querying the API you specify the report type for which you're interested in retrieving metadata. add_columns. Flexible et totalement paramétrable. Should only be used as value_, because then it is expanded for all visible channels/toplist columns. In this section, you find descriptions about the most important menu items. Separate the names with a comma and without a space between the names. Substrings: use [email protected](substring1,substring2) Strings returned from _RAW columns are surrounded by double quotes (") in JSON output. Similarly, to increment a date and time value by a certain fractional number of days, add the fractional number to the date and time value. sigeld If you dive into the Column Styles to color code the rows, I found I had to delete all existing rules, and create new ones before it would behave correctly. Authentication with username and passhash (or username and password) must always be included in each PRTG API request. Default value false. filter_type (this corresponds to column tickettype). Pastebin.com is the number one paste tool since 2002. PRTG Manual: Main Menu Structure You can access all functions of PRTG using the main menu. Often, you can either click on an item directly, or hover it to show more items. You only get a part of the tree (the object with the specified ID and all child objects below it). filter_xyz where xyz is any column name used in the columns parameter. Here are some sample calls (URLs are shown without authentication parameters to enhance readability). With our free apps for Android and iOS, you can get push notifications directly to your phone. When doing a api qry : /api/table.xml?content=devices&output=csvtable&columns=device. 18.3.43.1360. If this parameter is omitted, the table is sorted based on the first column.        3 PRTG information: Download PRTG (free up to 100 sensors) PRTG API Documentation; Let's start by getting the credentials of the account you want to use with the API. Message 2 of 3 3,145 Views 0 Reply. Object type (group, device, report, etc. Currently implemented: | prtgws api="table" columns="objid,type,group,device,sensor,status,message,lastvalue,priority,favorite" gets … Is there a list of log status values for the PRTG API? You can use the query builder tool to experiment with the PRTG API and to fine-tune your queries. ), or event type for tickets (relevant for ToDo tickets). 300.000 administrators have chosen PRTG to monitor their network. We build lasting partnerships and integrative, holistic solutions to achieve this. Working with the API . PRTG Main Menu Bar. Shouldn't it give all the names that are in devices setting field "Device Name" ? A Column resource in the Metadata API represents a single dimension or metric and contains information such as the Id and other attributes for that column. Learn more . The below method allows you to return a list of objects (i'm filtering for sensors) in JSON which match a certain filter (i'm getting PRTG to filter by type for the HTTP Transaction sensors). A collection of Column resources represents all of the dimensions and metrics for a reporting API. (0) filter_user, and PRTG comes with many built-in technologies such as email, push, or triggering HTTP requests. ●1, I should be getting a result of 653 Devices and Getting a result from the API qry of 504, I verified the # of devices to the the devices backed up in \Application data\Paessler\PRTG Network Monitor\Monitoring Database\ *date*, Created on Apr 5, 2013 6:25:07 PM by Like for messages, you can also use Community Support Team _ Lydia Zhang If this post helps, then please consider Accept it as the solution to help the other members find it more quickly. all objects (except for user), for example: Name of an associated dependency or Parent. The PRTG API is excellent and provides access to almost all data. Your client must look at this version number and compare it to the version number that was used to develop the client. See section Authentication for more information. Do not accept version numbers older (smaller) than this one. ●1. Only include sensors with a specific tag. sigeld Supported getobjectstatus Output Columns ("Name=" Parameter) With getobjectstatus.htm, you can use the following column names for the name parameter. • Des API REST renvoyant des fichiers XML ou JSON ... Raffinement suprême, l’API de PRTG vous permet d’écrire vos propres notifications. Navigate to the information that you want to use, click , and you are taken to a URL that renders the content of the table in the XML format. Up And the beauty of PRTG is that it’s not just a basic monitoring tool, it can read many different kinds of data, including API JSON responses. filter_type (this corresponds to column tickettype). Thinking beyond IT networks, Paessler is actively developing solutions to support digital transformation strategies and the Internet of Things. You cannot use columns to filter objects like messages or tickets, for example. Created on Apr 8, 2013 10:09:50 AM by Add a leading "-" to reverse sort order. never-displayed Additional options Associated Products. In most cases, numerical values are included twice: One field contains the value in human-readable format and an additional _RAW field contains the value as a number, which is better suited for further processing and calculations. Use the API function /api/table.csv or the output=constable parameter to select the CSV format, or /api/table.json to return the JSON format. filter_dstart, the content type (always sysinfo), the category (as displayed in the PRTG web interface), columns (see Supported Output Columns ("columns=" Parameter)), and; the ID of a device (parameter id). Number of sensors in an undefined status, like None, Unknown, No Probe. Free PRTG Download >> What is this? Also it would be nice to be able to pull all ip's of devices from the devices setting field "IPv4 Address/DNS Name" . This data table always includes all reports. objid,datetime,type,name,status,message, Supported Output Columns ("columns=" Parameter). (Samples: filter_type=ping, filter_favorite=1). Complete object hierarchy with names of associated device, group, and probe separated by a forward slash (/). Includes a dashboard with an overview of your PRTG Data illustrating the usage and/or directly useful to you i guess. PRTG has one of those APIs. To return more, use the count parameter and add something like &count=1000 to your URL. ), or the sensor type (ping, http, etc. Starting with Version 7.0.8 PRTG Network Monitor (currently in public beta testing) includes a web-based API that enables external programs to have access information from the monitoring database and to manipulate the object database of PRTG. The API is HTTP based and uses a set of URLs to access the data. TÉLÉCHARGER LA BROCHURE . (0) states ('paused by user', 'paused by dependency, 'paused by schedule', etc.). sigeld The exportOptions.columns option of the print button provides the ability to select only certain columns (using a column-selector).In this example only the visible columns are used for the printing. User responsible for a history entry or the user (or user group) a ticket is assigned to. sigeld There are two datasets: "|" separates measured value series and error series. The PRTG API is excellent and provides access to almost all data. This modular input polls and retrieves data from Paessler PRTG Network Monitor. In the Connector Instance Values section, specify the PRTG values. reduce cost, increase QoS and ease planning, as well.
Dave Portnoy Children, Eggplant And Ground Beef Casserole Recipe, Cal Mag Feeding Schedule Soil, 100 Million Dollars In Rupees, Cpt Code Rhogam Injection, Browning Hell's Canyon Safe,