Connect Auvik

Written By Christopher Scaminaci

Last updated 6 days ago

Auvik is a network monitoring and documentation platform. It automatically discovers the devices, networks and interfaces on your clients' networks, backs up device configurations, tracks performance and availability, raises alerts, and — with the Auvik SaaS Management add-on — inventories the SaaS applications your clients actually use.

Connecting Auvik to StackJack gives your AI assistant a focused family of auvik_ MCP tools — MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

Inventory the network — devices, networks, interfaces and device components, with the discovery and management state behind each one
Plan hardware refreshes — warranty and service-contract coverage, plus vendor end-of-sale, maintenance and end-of-support milestones
Read configuration history — the device configuration backups Auvik has captured, including the full configuration text
Investigate performance — historical bandwidth, CPU, memory and storage statistics; device uptime and outages; interface bandwidth and packet loss; component temperature and utilization; cloud ping checks
Triage alerts — search alert history by severity, status, entity and time, and read a single alert in full
Reconcile billing — the same client and per-device usage data Auvik uses to calculate your invoices
Audit access — operator notes attached to devices, networks and interfaces, plus the remote-access session trail
Inspect SNMP pollers — poller settings, the devices each one applies to, and their value history
Review SaaS usage (with Auvik SaaS Management) — discovered applications, their users, licences, security events and tags, including underutilized licences worth reclaiming
Dismiss an alert (on Pro plans) — the one action Auvik's API allows

How StackJack authenticates to Auvik

Auvik uses your Auvik user name plus that user's API key, sent as standard credentials on every request. There is no OAuth login, no consent screen, and nothing to refresh or expire.

Two things about this are worth understanding before you generate a key:

The key belongs to a user, not to an integration. You generate it from an Auvik user's own profile — there is no separate application to register.
The key inherits that user's role. Auvik API keys are not independently scoped. Everything your AI can see is exactly what that Auvik user can see. If a tool reports that access was denied while the connection itself tests fine, the key is valid and the user's role is the limit.

Because of this, Auvik recommends a dedicated service account for integrations. Assign its API Access Only role or a custom least-privilege role with the exact API permissions and client/site access your selected tools need. Do not use Auvik's built-in Read Only role: despite its name, its default permissions exclude API access.

Clusters

Auvik runs in regional clusters, and your API address depends on which one hosts your account. StackJack asks for a Cluster API URL in the form:

https://auvikapi.<cluster>.my.auvik.com

To find your cluster, sign in to Auvik and look at your browser's address bar — the cluster appears in the hostname. A us1 account, for example, uses https://auvikapi.us1.my.auvik.com. Leave the field blank and StackJack uses us1.

Domain prefix

Your Auvik account also has its own domain prefix — the subdomain you sign in under. Two of the tenant tools need it, so StackJack stores it alongside the credentials.

This is not the same as the cluster, and confusing the two is the most common setup mistake. The cluster is the regional part of the API address (us1); the domain prefix is your own account's subdomain.

Before you begin

In StackJack: you need a role that can manage connectors (tenant Owner, a co-owner, or an Administrator).
In Auvik: you need an Auvik user whose role covers the clients and data you want your AI to reach, and the ability to generate an API key for it.
Know your cluster and your domain prefix — both are visible while you're signed in to Auvik.

Step 1 — Choose the Auvik user

Create or choose a dedicated Auvik service account. Assign API Access Only or a custom role containing each required API permission and the client/site scope your AI should reach. The default API Access Only role covers a baseline set of inventory, alert, audit, configuration, lifecycle, usage, and tenant APIs; add permissions for any other selected tool families. Avoid the built-in Read Only role because it grants no API permissions by default.

Step 2 — Generate the API key

Sign in to Auvik as that user.
Click your user name in the side navigation.
Select Generate API Key.
Copy it immediately — Auvik shows the full key only when it is generated or regenerated.

Step 3 — Note your cluster and domain prefix

While you're still signed in, take both values from the address bar and your account settings:

the cluster (the regional part of the hostname) — you'll turn this into https://auvikapi.<cluster>.my.auvik.com
your domain prefix (your account's subdomain)

Step 4 — Add the credentials in StackJack

In the StackJack portal, open Connectors.
Find the Auvik card. Click How To Connect for the same steps inline, or Configure to enter the credentials.
Enter the Cluster API URL, the Auvik User Name, and the API Key.
Enter your Auvik Domain Prefix (optional, but the tenant-detail tools need it).
Click Save.

What happens when you save

The user name and API key are stored encrypted in Azure Key Vault — never in the StackJack database, and never shown back to you.
StackJack checks that the cluster URL is a genuine Auvik address before storing anything. A URL that doesn't belong to Auvik is rejected rather than saved.
If this is the first time you configure Auvik, a Free-tier subscription for the connector is created automatically so its Free tools work right away.
StackJack immediately live-validates the credentials against Auvik's own credential-check endpoint. Validation never blocks the save: you'll either see a success confirmation or a "saved but validation failed" warning with the reason.
The connector card shows the connection and validity status from then on.

On a later update you must re-enter the API key, but you can leave the domain prefix blank — StackJack keeps the value you saved before rather than clearing it.

Working with multiple clients

Auvik is built for MSPs, so most tools can be scoped to specific clients. How you do that differs by area, which is worth knowing when you're directing your AI:

Start with the tenant list. auvik_list_tenants returns the multi-clients and clients your Auvik user can reach. Its ids are what the other tools' client-scoping option consumes. In a multi-client environment this is the first call your AI should make.
Most tools scope optionally. Inventory, alerts, statistics and client usage accept a list of client ids; omit it and they span every client your user can see.
The SNMP poller tools require it. Auvik will not answer those four without an explicit client scope.
SaaS Management is separate. Those tools use their own client ids, which come from auvik_list_asm_clients — not from the tenant list. Your AI should treat them as a distinct starting point.

How Auvik returns results

Tools return the Auvik response body as-is. Lists come back a page at a time with cursors for the next and previous pages, and StackJack caps how large a single page can be so one call can't pull an unbounded result set. Your AI follows the cursors when it needs more.

Time-based reads (statistics, poller history) take a time range and an interval. A narrow interval over a long range can produce a very large amount of data — if a request seems slow, widening the interval or shortening the range is usually the fix.

Plans and available tools

Free includes reads for devices (inventory, discovery state, extended detail, warranty, lifecycle), networks, interfaces, components, entity notes and audits, configuration backups, alert history, client and device usage, statistics, SNMP poller settings and history, SaaS Management, tenants, and the credential check.
Pro adds the write action for dismissing an alert.
Business offers the same tool set as Pro with a higher monthly call quota.

See the generated Auvik tool reference for the current inventory, plan assignment, input schemas, and destructive-action labels.

Auvik has no per-user login flow, so there is no per-user attribution — all AI traffic authenticates as the Auvik user whose key you configured. Current pricing and quotas are shown in the portal's Billing page and at checkout.

Safety note. Auvik's API is almost entirely read-only, and StackJack keeps the one exception clearly marked: Auvik provides no way to un-dismiss an alert, so dismissing one is irreversible. That tool is Pro-gated and marked destructive. Whether your AI application asks you to confirm before running it depends on that application's own settings — see Destructive tools and confirmation. Review those settings, and use the tool selections on the MCP Setup page and the Permissions page to enable only what you want an AI to do.

Rate limits

Auvik publishes a limit of 2,500 requests in a 5-minute period and documents that excessive traffic from one source IP can also be blocked for that window. StackJack paces each tenant below the individual allowance and backs off automatically when Auvik signals throttling. Because hosted tenants can share an egress IP, a 429 or temporary source-IP block can still occur even when one tenant has not exhausted its local allowance; wait for the five-minute window to reset and narrow or serialize broad reads.

Rotating or replacing the credentials

The API key is the recovery secret. If you regenerate it in Auvik — or the user's role changes, or the user is removed — the stored credential stops working. To restore access, open Connectors → Auvik → Configure in StackJack, paste the new key, and Save. You can leave the domain prefix blank to keep the value already saved.

Troubleshooting

Symptom	Likely cause	What to do
"Saved but validation failed" right after saving	Mis-typed user name or key, or the wrong cluster	Re-check the cluster against the address you sign in to Auvik with, then re-enter the user name and key
The cluster URL is rejected when you save	The URL isn't an Auvik address	Use `https://auvikapi.<cluster>.my.auvik.com`, taking the cluster from your Auvik dashboard address
Tools worked, then everything started failing	The API key was regenerated, or the Auvik user was disabled or removed	Generate a new key and update it in Connectors → Auvik → Configure
One area returns a permission error while the rest works	The Auvik user's role doesn't cover that area	Grant that user the role permission in Auvik, or generate the key from a user that already has it
Every SaaS Management tool reports access denied	Your account doesn't have the Auvik SaaS Management add-on	These tools need that product. Without it the rest of the connector is unaffected
The four SNMP poller tools fail while others succeed	Auvik requires an explicit client scope on those	Ask your AI to list tenants first and pass the client ids through
The two tenant-detail tools report a missing domain prefix	No domain prefix is saved	Add it in Connectors → Auvik → Configure — remember it is your account subdomain, not the cluster
A statistics call times out or returns far too much	Too narrow an interval across too long a range	Widen the interval or shorten the time range
The dismiss-alert tool is missing from your AI's tool list	Connector is on the Free tier, or the tool isn't selected for your client	Upgrade the Auvik connector plan and check your tool selections on the MCP Setup page

Auvik tools

auvik_ · 50 tools · Free 49 · Pro 1

General

Tool	What it does
`auvik_verify_credentials` Free · Read-only	Verify that the configured Auvik user name and API key authenticate.

Tenants

Tool	What it does
`auvik_get_tenant_detail` Free · Read-only	Get one tenant's detail by tenant id (ids come from auvik_list_tenants).
`auvik_list_tenant_details` Free · Read-only	List DETAIL for the tenants associated with your Auvik account — richer per-tenant information than auvik_list_tenants returns.
`auvik_list_tenants` Free · Read-only	List every Auvik tenant — multi-client and client — that the configured Auvik user can reach.

Devices

Tool	What it does
`auvik_get_device_detail` Free · Read-only	Get one device's discovery and management state by device id (from auvik_list_device_info) — per-protocol discovery status, managed/billable flag, and TrafficInsights state.
`auvik_get_device_extended_detail` Free · Read-only	Get one device's extended hardware/software details by device id (from auvik_list_device_info).
`auvik_get_device_info` Free · Read-only	Get one device's core inventory attributes by device id (ids come from auvik_list_device_info).
`auvik_get_device_lifecycle` Free · Read-only	Get one device's lifecycle milestones (end-of-sale, software and security maintenance, last support) by device id (from auvik_list_device_info).
`auvik_get_device_warranty` Free · Read-only	Get one device's warranty and service-contract coverage by device id (from auvik_list_device_info).
`auvik_list_device_details` Free · Read-only	List device DISCOVERY and MANAGEMENT state — per-protocol credential/discovery status (SNMP, WMI, login, VMware), whether the device is billed as managed, and TrafficInsights forwarding state.
`auvik_list_device_extended_details` Free · Read-only	List EXTENDED device details — the deeper hardware/software attributes Auvik collects beyond the basic inventory (per-type fields such as firmware/OS versions, chassis and stack members, virtualization specifics).
`auvik_list_device_info` Free · Read-only	List discovered devices with their core inventory attributes (name, IP addresses, make/model, vendor, device type, online status, serial number, last-seen time).
`auvik_list_device_lifecycles` Free · Read-only	List device LIFECYCLE status — vendor end-of-sale, software-maintenance, security-maintenance, and last-support milestones per device.
`auvik_list_device_warranties` Free · Read-only	List collected WARRANTY and support-contract coverage per device — coverage flags plus contract/expiry information Auvik gathered from the vendor.

Networks

Tool	What it does
`auvik_get_network_detail` Free · Read-only	Get one network's scanning and collector configuration by network id (from auvik_list_network_info) — scope, primary and secondary collectors, collector selection, and excluded IP addresses.
`auvik_get_network_info` Free · Read-only	Get one network's core attributes by network id (ids come from auvik_list_network_info).
`auvik_list_network_details` Free · Read-only	List network DETAIL — the scanning and collector configuration behind each discovered network: public vs private scope, which collector polls it (primary and secondary), how the collector was selected, and any excluded IP addresses.
`auvik_list_network_info` Free · Read-only	List the networks Auvik discovered, with their core attributes (network name, address range, network type, scan status, description).

Interfaces

Tool	What it does
`auvik_get_interface_info` Free · Read-only	Get one interface's attributes by interface id (ids come from auvik_list_interface_info).
`auvik_list_interface_info` Free · Read-only	List the interfaces Auvik discovered on client devices — interface name and type, parent device, administrative state, operational status, addressing, and speed.

Components

Tool	What it does
`auvik_get_component_info` Free · Read-only	Get one component's attributes and current health status by component id (ids come from auvik_list_component_info).
`auvik_list_component_info` Free · Read-only	List device COMPONENTS — the sub-parts Auvik monitors inside each device: CPUs and cores, disks, fans, memory, power supplies, and system boards, each with its current health status.

Entity Notes & Audits

Tool	What it does
`auvik_get_entity_audit` Free · Read-only	Get one entity audit entry by audit id (ids come from auvik_list_entity_audits) — the session's user, category, status, target entity and timing.
`auvik_get_entity_note` Free · Read-only	Get one entity note by note id (ids come from auvik_list_entity_notes), including its full text and the entity it annotates.
`auvik_list_entity_audits` Free · Read-only	List the entity AUDIT trail — the record of remote-access sessions run against client entities through Auvik (tunnels, terminal sessions, remote browser sessions), with the user who initiated each one, its outcome, and when.
`auvik_list_entity_notes` Free · Read-only	List the operator-written NOTES attached to entities — devices, networks and interfaces — with their text, the entity they annotate, who last edited them, and when.

Configurations

Tool	What it does
`auvik_get_configuration` Free · Read-only	Get one configuration capture by id (ids come from auvik_list_configurations), including the full configuration TEXT as Auvik stored it.
`auvik_list_configurations` Free · Read-only	List the device configuration BACKUPS Auvik has captured — one entry per capture, with its device, backup time, and whether it is the running or a stored configuration.

Alerts

Tool	What it does
`auvik_dismiss_alert` Pro · Destructive	Dismiss a single Auvik alert.
`auvik_get_alert` Free · Read-only	Get one alert in full by alert id (ids come from auvik_list_alerts) — its severity, status, triggering entity, detection and resolution times, and any related alert.
`auvik_list_alerts` Free · Read-only	Search Auvik ALERT HISTORY — the alert events the collectors have raised, with severity, current status, the entity that triggered them, detection time, and whether they were dismissed or dispatched.

Usage & Billing

Tool	What it does
`auvik_read_client_usage` Free · Read-only	Read a client's billable USAGE summary for a date window — and, for a multi-client, its children's too.
`auvik_read_device_usage` Free · Read-only	Read one device's billable usage over a date window.

Statistics

Tool	What it does
`auvik_read_component_statistics` Free · Read-only	Read historical COMPONENT metrics as a time series — the inside-the-box telemetry for CPUs, disks, fans, memory, power supplies and system boards.
`auvik_read_device_availability_statistics` Free · Read-only	Read historical device UPTIME or OUTAGE statistics as a time series.
`auvik_read_device_statistics` Free · Read-only	Read historical DEVICE performance metrics as a time series.
`auvik_read_interface_statistics` Free · Read-only	Read historical INTERFACE metrics as a time series — throughput, utilization, and error/loss counters per port.
`auvik_read_oid_statistics` Free · Read-only	Read the CURRENT value of numeric SNMP pollers (device monitors).
`auvik_read_service_statistics` Free · Read-only	Read historical CLOUD PING CHECK statistics — the reachability probes Auvik runs against monitored services.

SNMP Pollers

Tool	What it does
`auvik_get_snmp_poller_setting` Free · Read-only	Get one SNMP poller setting by its id (ids come from auvik_list_snmp_poller_settings) — its name, OID, value type and usage.
`auvik_list_snmp_poller_setting_devices` Free · Read-only	List the DEVICES a given SNMP poller setting applies to, with each device's online status and identifying attributes.
`auvik_list_snmp_poller_settings` Free · Read-only	List the custom SNMP POLLER SETTINGS configured in Auvik — each one's name, the OID it polls, whether it is a string or numeric poller, and what it is used as.

SNMP Poller History

Tool	What it does
`auvik_read_snmp_poller_int_history` Free · Read-only	Read the historical values of NUMERIC SNMP pollers over a time range, aggregated by interval.
`auvik_read_snmp_poller_string_history` Free · Read-only	Read the historical values of STRING SNMP pollers over a time range.

SaaS Management

Tool	What it does
`auvik_list_asm_applications` Free · Read-only	List the SaaS APPLICATIONS Auvik discovered in use at a client — what is actually being signed into, when it first appeared, and (via include) its publisher, contracts, users, access data, and known breaches.
`auvik_list_asm_clients` Free · Read-only	List the clients covered by Auvik SaaS Management.
`auvik_list_asm_licenses` Free · Read-only	List the LICENCES assigned within one SaaS application at a client — who holds which licence type and when they last signed in.
`auvik_list_asm_security_logs` Free · Read-only	List SaaS SECURITY EVENTS Auvik recorded for a client — the security-relevant activity across their SaaS applications.
`auvik_list_asm_tags` Free · Read-only	List the TAGS applied within a client's Auvik SaaS Management data — how the client's applications have been categorized (sanctioned, under review, and so on).
`auvik_list_asm_users` Free · Read-only	List the SaaS USERS Auvik discovered at a client — the people whose accounts show up across the client's SaaS applications.

Still need help? Ask the team