Skip to main content
The Auvik user whose API key you use must have the role permissions for the APIs you intend to call.

Sign in and find your connection details

Sign in to Auvik and gather the values for the connection.

1

Sign in to Auvik

Sign in to your Auvik account.

  • The email address you sign in with is your Username.
2

Find your Region / Cluster

Your Region / Cluster is the cluster segment of your Auvik dashboard URL.

  • Check your browser address bar when signed in to Auvik.
  • Format: https://{site}.{region}.my.auvik.com
  • Example: if your URL is https://sandbox1.lnx.my.auvik.com, your Region / Cluster is lnx
  • Common values: us1, us2, us3, us4, eu1, au1
  • If you enter a different valid region, or your account is later moved between clusters, Auvik responds with a 308 redirect to your account’s actual cluster and the connection still succeeds — so a mismatched-but-valid region is not rejected. Use your current Region / Cluster for the most direct routing.

Generate your API Key

Generate an API Key from your user profile. This is used as the connection password.

1

Open your profile

Click your account name in the bottom-left navigation, then select Edit Profile.

  • Scroll to the API Key section at the bottom of the profile page.
  • The Domain Prefix shown here (e.g. sandbox1) is your site name — not the Region / Cluster.
2

Generate and copy the key

In the API Key section, click Regenerate to create a new key. The button may read Generate if you have never created one.

  • In the Generate/Regenerate API Key dialog, click Copy to copy the key, then click DONE to apply it.
  • Store it securely now — Auvik displays the full API key only once and you will not be able to retrieve it at a later date.
  • Regenerating immediately invalidates any previous key, so update anywhere the old key is used.

Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Region / Cluster
  • Username
  • API Key
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.