Home
Vantage
Administrator Guide
Information about the Administration section of Vantage, and the tasks that you can do in this part of the software.
Administration
Teams
API keys
Generate an API key
Before you can use an API key, you must generate one.

Vantage
- Introduction
  An overview of Vantage.
- Administrator Guide
  Information about the Administration section of Vantage, and the tasks that you can do in this part of the software.
  - Administration
    - Administration page
      The administration page lets a user with administrator privileges configure settings and do other tasks.
    - System
    - Teams
      - Organizations
        The Organizations page shows your organizations, which are logical subdivisions within your Vantage account.
      - Groups
        The Groups page shows all the user groups in your organization, and lets you create and configure groups.
      - Users
        The Users page shows all the users that have been assigned in Vantage.
      - API keys
        API keys in Vantage
        For third-party applications that integrate with Vantage, you must use API keys to authenticate them.
        API authentication
        Once you have the API key name and token from Vantage, you can define your API calls, including enabling authentication of a third-party application.
        Considerations when you connect multiple applications to Vantage
        It is important to choose the correct approach when you want to connect multiple applications to Vantage. In many cases, you can create a single user that all of your applications use to access Vantage. However, if you have several applications that perform different kinds of task, each application may need its own user dedicated to its exclusive use.
        API Keys
        The API Keys page shows a list of all the API keys for every organization in the account.
        Generate an API key
        Before you can use an API key, you must generate one.
        Revoke an API key
        Once an API key has been created, you cannot edit it. You can only revoke it.
        API authentication examples
    - Organization Settings
  - Migration
  - SAML integration
- User Guide
  Information about the main features of Vantage and the tasks that you can do from the user interface (UI).
- Print format documentation
  A list of all the print-format documentation that is available for Vantage.

Generate an API key

Before you can use an API key, you must generate one.

Before you do this procedure, make sure that you have:

Created a user to associate with your third-party application
Assigned the user a role that grants the necessary permissions and scope within Vantage

Once an application programming interface (API) key has been created, you cannot edit it. You can only revoke it.

Log into Vantage as the user who will own the API key.
In the top navigation bar, select > Profile.
Select API Keys.
The API Keys page opens.
In the Description field, enter a description for the API key.

Note: Nozomi Networks recommends that the description includes the name of the application that will connect with the API key.
Optional: Enter a range of allowed internet protocol (IP) addresses in the Allowed IPs field. Only applications within this range will be permitted to connect with this key.

Note: For these settings, you must use comma-delimited entries, in classless inter-domain routing (CIDR) format. Values here will override the values in the SECURITY section on the General page.
In the Organization field, select the organization that will be the default for this API key.

Note: If an API request that uses this key doesn't include an organization, the default organization is used.
Select Generate.
Vantage generates a key and displays its:
- Key name
- Key token
- Allowed ips
- Linked organization
Important: You will need some of these values when you configure your third-party application. While the name is shown in the Vantage user interface (UI) after this point, the token is not shown again. If you lose this data, you must generate a new API key.
Record these details:
- Key name
- Key token
- Allowed ips