> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# PRTG API

> Read PRTG sensors, devices, alarms and history; put alert tickets on the right customer, acknowledge alarms, pause objects and change settings — each change follows the approval settings you give it

An agent with this tool answers a monitoring ticket from your PRTG data: which sensor and device it is about, whether the device or its probe is down, what the sensor's values did, and which customer it belongs to.

> [!NOTE]
>
> Automatically enabled when you configure PRTG permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find the sensor behind a ticket by its id in the alert email, or by device and sensor name, and the device by host name or IP
* Read a sensor's status, message, last value and channels, and every sensor of its device, to tell a device that is down from one failed service or a disconnected probe
* Put an alert ticket on the customer the sensor belongs to, from its `neo-customer-<number>` tag or the Organization Mapping tab, and merge a repeat or Up email into the sensor's open ticket
* Read historic data, the PRTG log, an object's change history, PRTG's own tickets and reports
* Acknowledge an alarm with the ticket number
* Pause and resume sensors, devices, groups and probes for planned work, and scan a sensor now
* Change settings, channel limits and tags, clone, move and delete objects, run auto-discovery, and read notification templates and triggers, with the access and approvals you choose
* Use PRTG's API v2 (objects, time series, users and API keys) when the PRTG connection has an API v2 address

The agent calls PRTG through the [Vendor API](https://docs.neoagent.io/agents/tools/vendor-api.md) tool, with `prtg` as the vendor id. [Sandbox](https://docs.neoagent.io/agents/tools/built-in/sandbox.md) scripts can call PRTG too, under the same permissions.

## Permission Groups

| Group | What it covers |
| - | - |
| **Sensors and Devices** | Probes, groups, devices, sensors and channels with their status, details, tags and system information. Write scans now |
| **Alarms** | Sensors in an alarm. Write acknowledges an alarm with a message |
| **History and Logs** | Historic data and time series, the log of status changes, and an object's change history |
| **Pause and Resume** | Pause and resume objects, for a number of minutes or until resumed |
| **Configuration** | Settings and properties, channel limits, tags, notification templates and triggers, schedules, clone, move, add, auto-discovery and delete |
| **PRTG Tickets** | PRTG's own tickets and their history (read only) |
| **Reports** | Reports and their stored PDFs; add an object to a report |
| **Users and API Keys** | Users, user groups and API keys (API v2): pause and resume users, change or delete a key |
| **Server Status** | The core server's status, health, version and license |

Every group can be Disabled, Read Only or Read/Write, except PRTG Tickets, which PRTG's API only reads. Neo never sends these calls: PRTG sessions, password resets and the passhash lookup (Neo signs in with the API key), creating an API key or looking one up by its value (a secret), and the live graph images (the agent reads values instead). Neo never reads a property whose name holds a credential, and it hides passwords, community strings and tokens in every answer. A bulk API v2 action with no filter, which would act on every object, is refused.

## Access Profiles

> [accordion] Read Only
>
> Every group Read Only. The agent reads, and never changes anything.

> [accordion] Helpdesk
>
> Alarms and Sensors and Devices are Read/Write without approval. Pause and Resume is Read/Write with technician approval. Everything else is Read Only.

> [accordion] IT Admin
>
> Every group Read/Write. Configuration and Users and API Keys require technician approval.

> [accordion] Full Automation
>
> Every group Read/Write without approval, except the changes below, which still require technician approval.

## Changes that always ask a technician

These require technician approval under every access profile, whatever the group's own approval setting:

* Deleting a probe, group, device or sensor, which deletes everything under it with no undo.
* Putting a sensor into an error on purpose, which sends its real notifications.
* Changing or deleting an API key.
* Any change that stores a credential, such as a password, a private key or an SNMP community string.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.