> ## 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.

# Auvik API

> Read Auvik devices, online status, uplinks, alerts, statistics, tenants and billing usage, and dismiss an alert — dismissal follows the approval setting you give it

An agent with this tool answers a network ticket from the client's Auvik data: is the device really down, when Auvik last saw it, which switch ports it connects to, and which Auvik alerts are open on it.

<Info>
  Automatically enabled when you configure Auvik permissions in your agent workflow. No manual toggle needed.
</Info>

## What It Does

* Find the client's Auvik tenant (a site in the Auvik UI)
* Find a device by name, IP address, serial number or MAC address, and read its online status and when Auvik last saw it
* Read the device's outage history, the devices and switch ports it connects to, and the state of each likely uplink. Auvik does not mark which neighbour is the uplink, so with more than one the agent lists each
* Read the open Auvik alerts on the device or its uplink, and dismiss an alert once the condition has cleared and the ticket is resolved
* Read device details, warranty and end of life, networks, interfaces, components and configuration backup times
* Read bandwidth, CPU, memory and interface statistics, and SNMP poller settings and history
* Read billable device days per client for a month, and the average billable devices per site
* Match Auvik devices to ConnectWise configurations by the Auvik device id field, serial number, MAC address or name, and list the devices with no match on each side. The agent changes a configuration only when your instructions ask and the agent has ConnectWise **Configurations** write access
* Find the Auvik alert behind a ticket that Auvik opened in your PSA
* Read Auvik SaaS Management apps, users and licenses

The agent calls Auvik through the [Vendor API](/agents/tools/vendor-api) tool, with `auvik` as the vendor id. [Sandbox](/agents/tools/built-in/sandbox) scripts can call Auvik too, under the same permissions.

## Permission Groups

| Group | Access levels | What it covers |
| - | - | - |
| **Inventory** | Disabled, Read Only | Devices, interfaces, networks and components: online status, last seen, connected devices, details, warranty, lifecycle and configuration backup times |
| **Alerts** | Disabled, Read Only, Read/Write | Alert history. Write dismisses an alert |
| **Statistics** | Disabled, Read Only | Device, interface, component, service and OID statistics, outage history, and SNMP poller settings and history |
| **Tenants and Billing** | Disabled, Read Only | Your Auvik tenants and billing usage per client |
| **Notes and Audit** | Disabled, Read Only | Notes your technicians typed on devices and networks in Auvik, and the audit log. Off in every profile, because notes are free text and can hold passwords |
| **SaaS Management** | Disabled, Read Only | Auvik SaaS Management apps, users, licenses, tags and security log per client |

Neo sends Auvik reads and one write, dismissing an alert. Nothing Neo sends to Auvik changes a network device.

## Access Profiles

<AccordionGroup>
  <Accordion title="Read Only">
    Every group Read Only except Notes and Audit, which stays off. The agent reads, and never dismisses an alert.
  </Accordion>

  <Accordion title="Helpdesk">
    Reads the same groups. Dismissing an alert waits on a technician.
  </Accordion>

  <Accordion title="IT Admin">
    Reads the same groups. Dismissing an alert waits on a technician.
  </Accordion>

  <Accordion title="Full Automation">
    Reads the same groups and dismisses alerts without approval.
  </Accordion>
</AccordionGroup>

To let an agent read Auvik notes, turn **Notes and Audit** to Read Only by hand. Do it only if your Auvik notes hold no passwords or keys.

## Not available through Neo

Auvik's published API has no operation that runs a command on a device, pushes a configuration, or exports a configuration backup, so Neo cannot do these. The agent reads only when a backup was taken.

## Setup

See [Connecting Auvik to Neo](/integrations/auvik/connecting-to-neo).


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