Home
Vantage
Learn how Vantage uses the power and simplicity of SaaS to deliver unmatched security and visibility across your OT, IoT and IT networks.
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
Rotate an API key
Rotate an existing API key in Vantage to replace it with a new one while maintaining access continuity. Key rotation enhances security by minimizing the risk of compromised credentials.

Vantage
Learn how Vantage uses the power and simplicity of SaaS to deliver unmatched security and visibility across your OT, IoT and IT networks.
- 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.
      - Roles
        The Roles page shows all the assigned user roles in Vantage. It also lets you create new roles, and manage permissions and access levels efficiently.
      - 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. Once a key is created, it cannot be edited, it can only be revoked or rotated.
        Revoke an API key
        Revoke an API key in Vantage to immediately disable access for that credential. This action is irreversible and should be used when a key is no longer needed or may be compromised. Revoking a key does not impact other active keys.
        Rotate an API key
        Rotate an existing API key in Vantage to replace it with a new one while maintaining access continuity. Key rotation enhances security by minimizing the risk of compromised credentials.
        API authentication examples
    - Organization Settings
  - 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.

Rotate an API key

Rotate an existing API key in Vantage to replace it with a new one while maintaining access continuity. Key rotation enhances security by minimizing the risk of compromised credentials.

Procedure

Log into Vantage as an administrator.
In the top navigation bar, select
The administration page opens.
In the Teams section, select API Keys.
The API Keys page opens.
In the Key name column, hover your mouse over the application programming interface (API) key that you want to rotate.
The icon shows.
Select the icon.
A dialog shows.
Select Confirm.

Results

The API key has been rotated.