You can regenerate the key value for an API key. When you regenerate a key, the nickname for the key is kept and the key value is replaced.

Key regeneration can be used for the following purposes.

  • Periodic key regeneration is a good security practice to safeguard your site's API keys.
  • You can regenerate a key as a shortcut to halt logs from all sources using that API key. When you regenerate the key without configuring for the new key value, VMware Aria Operations for Logs (SaaS) no longer recognizes the log source and stops receiving messages from the source.

After you regenerate a key, you must reconfigure connections to use new API key value.

Procedure

  1. Click the two arrows icon in the upper-left corner of the screen to expand the main menu.
  2. Navigate to Configuration > API Keys.
  3. Locate the key whose value you want to regenerate and click the three dots icon to the left of its key name to open the Regenerate API Key window.
  4. Click Regenerate.
    A new key value is created for the named key.

What to do next

Reestablish a connection to data sources that use the key, updating configuration with the new key value. See Specifying an API Key for a Log Source.