Skip to main content
You connect Auvik once at the MSP level, with one Auvik user’s email and API key.

1. Prepare an Auvik user

1

Pick or create the user

Auvik recommends a user made for API access. Give it the built-in API Access Only role, or a role with API access, and access to your clients.The built-in role covers devices, interfaces, networks, alerts, notes, tenants and billing. To let agents read statistics, SNMP pollers or SaaS Management, add those API permissions to the role, or use a custom role. To let agents dismiss alerts, the role may need Access and Edit on API - Alerts. The built-in role gives View there.
2

Generate the API key

Sign in to Auvik as that user, open the user’s profile, and click Generate API Key. Copy the key: Auvik shows it once.
3

Note your region

Your region is in your Auvik address. If you sign in at https://acme.us1.my.auvik.com, the region is us1.
Do not regenerate the key in Auvik after you connect it. Regenerating replaces the key at once, and Neo loses access until you save the new key here.

2. Add the key in Neo

1

Open Integrations

In the Neo Dashboard, open Integrations → Auvik, under Networking.
2

Save the key

Enter the region (or paste your Auvik address), the user’s email and the API key, then click Save settings. Neo checks them against Auvik before saving, so a wrong key or a wrong region is rejected straight away, and the error names the right region when Auvik reports one.

3. Turn Auvik on per agent

Open the agent, go to its Tools & Settings tab, click Networking, and expand the Auvik block. Agents read only the clients the Auvik user can see.

Pick a preset

Read Only

Read devices, alerts, statistics, tenants and billing. Nothing is changed.

Helpdesk

Read the same. Dismissing an alert waits on a technician.

IT Admin

Read the same. Dismissing an alert waits on a technician.

Full Automation

Read the same and dismiss alerts without approval.
Notes and Audit stays off in every profile. Auvik notes are free text, and they can hold passwords. Turn it to Read Only by hand only if your notes hold no passwords or keys.

Or set each area by hand

Alerts also has its own technician approval setting.

Example: a network device is down

Give an agent that runs on your device-down tickets the Helpdesk profile and instructions like these:
When a ticket says a network device is down, check the device in Auvik: its online status, when Auvik last saw it, and the switch port it connects to, and write what you found in an internal note.
See Auvik API for what the agent can read.

Safety controls

  • Read only, apart from one write. Neo sends Auvik reads and one write, dismissing an alert. Nothing Neo sends to Auvik changes a network device.
  • You decide whether dismissing waits on a technician. Helpdesk and IT Admin ask first; Full Automation does not.
  • Notes stay off. Notes and Audit is off in every profile, because Auvik notes can hold passwords.
  • Only Auvik hosts. Neo sends the key only to the Auvik API host of your region.
  • Path safety. A URL path with a .. segment is rejected before it reaches Auvik.

If Auvik moves your account

Auvik can move an account to another region. Neo then stops and tells the technician the new region. Open Integrations → Auvik, set the region, enter the API key again and save.