Nozomi Vantage uses API keys to authenticate requests. You will need to create an API key to configure the integration. This guide walks you through the process of creating an API key and optionally a group and service account with minimal permissions.

Create a Nozomi Vantage API Key

1. Log in to Nozomi Vantage as an Admin

Once logged in, in the top navigation bar, under the cog, navigate to Profile and then the Groups section under Teams.

2. Create a new Service Account (optional)

Adding a new user will allow you to narrow the scope of the API key. The creation of a new user for the API key is optional; however, it is strongly recommended so that you can limit the permissions of the API key.

First, you need to create a group with minimal permissions.

In the Teams section, select Groups. Enter a Group Name and click Create.

Once completed, select the new group by clicking on its name. Select Role assignments, and using the Roles dropdown, assign the following role:

• Observer

Next you will create a user and assign them to the group. In the Teams section, select Users, and then select Invite. Enter a name for the user and email address. This email address should not be associated with a real user account, and instead a shared mailbox. You must have access to this mailbox to receive the invitation email.

In the Initial Group dropdown, select the group you just created. And finally click Invite.

Check the email inbox for the shared mailbox and click the link in the email to finalize the user creation.

3. Create an API Key

Log on to Nozomi Vantange as the user who will own the API key. This can be the user you just created or an existing user; however, it is recommended to use the user you just created.

In the top navigation bar, select the user icon and then Profile. Next select API Keys.

Enter a description for the API key in the Description field. This should be something that will help you identify the key later.

Leave the Allowed IPs field blank to allow the key to be used from any IP address.

Select the organization you wish to use for the integration in the Organization field, and then select Generate.

Save the Key token value that is displayed in a secure location. This value will not be displayed again.

Configure the Integration

Create your integration by supplying the following values.

URL The root URL of your Nozomi Vantage instance. This may be in the format https://tenant.customers.us1.vantage.nozominetworks.io/.

Token This is the API Key value gathered in step 3.