> ## Documentation Index
> Fetch the complete documentation index at: https://university.triggr-app.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Auvik

> Connect Auvik Network Management to Triggr with an API-only Auvik user and API key, then map your clients to Auvik sites.

Triggr reads Auvik sites, devices, networks, configuration backups, alerts, statistics, SNMP pollers, billing usage and SaaS Management data, and dismisses alerts.

## Set up Auvik

You need a mailbox for a dedicated Triggr user in Auvik. If Auvik uses Single Sign-On for All Users, the user must also exist in your identity provider.

<Steps>
  <Step title="Choose a role">
    The built-in API Access Only role covers most actions. For Dismiss Alert or SNMP pollers, go to **Manage Users > Roles > Add Role** on your multi-site dashboard, tick API Role Only and select the [permissions](#permissions) you need. Don't use Read Only, which has no API permissions.
  </Step>

  <Step title="Invite a Triggr user">
    In Manage Users, click **Invite User** and enter an address such as `triggr@yourcompany.com`. Select every site Triggr should work with, give the user the role on each and click Invite. Authorise the user on sites you add later, too.
  </Step>

  <Step title="Generate an API key as that user">
    Accept the invitation and sign in as the Triggr user (only users can generate their own keys). Click the username in the side navigation bar, click **Generate API Key** and copy the key. Auvik shows it only once.
  </Step>

  <Step title="Find your region">
    It's the three characters before `my.auvik.com` in your Auvik address, such as `us2` in `https://yourcompany.us2.my.auvik.com`.
  </Step>
</Steps>

See Auvik's [API access only role](https://support.auvik.com/hc/en-us/articles/360022803872-API-access-only-role) article.

### Permissions

API Access Only includes every permission below except the last two rows. The SaaS Management actions also need an Auvik SaaS Management subscription.

| Auvik permission | Triggr actions |
| - | - |
| API - Tenants | Client mapping, List Tenants, List Tenant Details, Get Tenant Details |
| API - Device Info | List Device Info, Get Device Info |
| API - Device Details | List Device Details, Get Device Details |
| API - Device Details Extended | List Device Extended Details, Get Device Extended Details |
| API - Hardware Lifecycle | List Device Lifecycles, Get Device Lifecycle |
| API - Network Info | List Network Info, Get Network Info |
| API - Network Details | List Network Details, Get Network Details |
| API - Interface Info | List Interface Info, Get Interface Info |
| API - Components | List Component Info, Get Component Info |
| API - Configuration History | List Device Configurations, Get Device Configuration |
| API - Entity Notes | List Entity Notes, Get Entity Note |
| API - Audit History | List Entity Audits, Get Entity Audit |
| API - Usage | Get Client Usage, Get Device Usage |
| API - Alerts | List Alert History, Get Alert History Entry |
| API - Alerts at Access and Edit | Dismiss Alert |
| The Poller API permissions, plus API - Device Details | The SNMP poller actions |

## Connect it in Triggr

<Steps>
  <Step title="Open the integration">
    Go to **Integrations > Auvik** and click **Configure** on the Base Configuration card.

    <Frame>
      <img src="https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/integrations-common/base-configuration.png?fit=max&auto=format&n=nyuVXZ1rouDTTEvu&q=85&s=bb81acb082055015f91beda7b4876f35" alt="The Base Configuration card with Status Not Configured, Admin Consent Not Required and a Configure button." width="2272" height="330" data-path="images/integrations-common/base-configuration.png" />
    </Frame>
  </Step>

  <Step title="Enter the credentials">
    Enter the API Key, choose your Region, enter the Triggr user's sign-in email address as Username, then click **Save Configuration**.

    <Frame>
      <img src="https://mintcdn.com/triggr/MwzXHG3UWzFixdSz/images/auvik/configure.png?fit=max&auto=format&n=MwzXHG3UWzFixdSz&q=85&s=2c4524df0c725b18c21af15b187f5423" alt="The Auvik configuration window with an API Key field, a Region drop-down and a Username field, each with a hint, an Allow insecure TLS switch under Advanced, and a Save Configuration button." width="1344" height="1546" data-path="images/auvik/configure.png" />
    </Frame>
  </Step>
</Steps>

## Map your clients

On the Client Mapping card, click **Apply 100% Matches**, then choose the Auvik site in Mapped to for anyone left. A client can map to several sites. Multi-sites aren't listed, and sites are named by their domain prefix (`acme` in `acme.us1.my.auvik.com`), so short prefixes may need mapping by hand.

<Frame caption="The Client Mapping card, shown here for ConnectWise Manage as an example.">
  <img src="https://mintcdn.com/triggr/nyuVXZ1rouDTTEvu/images/integrations-common/client-mapping.png?fit=max&auto=format&n=nyuVXZ1rouDTTEvu&q=85&s=da797e78dc917005df8e55c6b6cb166b" alt="The Client Mapping card with All, Mapped and Unmapped filters, Acme Corp mapped to Acme Corp with a 75% suggested mapping, and Globex unmapped with a Select ConnectWise Manage clients dropdown." width="2272" height="702" data-path="images/integrations-common/client-mapping.png" />
</Frame>

Triggr saves the mapping as the client's `auvikTenantId`, `auvikTenantIdCsv` and `auvikTenantIdList` variables. Pass `{{ ctx.client.auvikTenantIdCsv }}` as `tenants` on list and statistics actions, or `{{ ctx.client.auvikTenantIdList[0] }}` where an action takes one `tenantId`. To follow `links.next` to the next page of results, use a Generic Integration Action step with URL Type set to Absolute URL.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Every action fails with 401">
    Check Username is the full sign-in email, the key hasn't been regenerated, and Region matches your Auvik address, which Auvik occasionally moves. Verify Credentials returns 200 when the username and key are valid.
  </Accordion>

  <Accordion title="An action fails with 403">
    The role lacks the action's [permission](#permissions), or the user isn't authorised on every site in `tenants`. After a rate limit, Auvik can also return 403 until its five-minute window resets.
  </Accordion>

  <Accordion title="Sites are missing from Client Mapping">
    Authorise the Triggr user on the site with a role that includes API - Tenants, then click Refresh on Client Mapping. Map clients to the sites under a multi-site, not the multi-site.
  </Accordion>

  <Accordion title="Requests fail with 429">
    Auvik allows 2,500 API requests in five minutes. Spread workflows that loop over many clients or pages out over time.
  </Accordion>

  <Accordion title="Statistics requests time out">
    Ask for fewer tenants per call, a smaller page, and a shorter time range or coarser interval.
  </Accordion>
</AccordionGroup>


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