Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Insight

Acquire an API key for data retrieval

  • Last UpdatedOct 03, 2025
  • 2 minute read

When you use token authentication for data retrieval requests, you must specify a bearer token in the authorization header. In most cases, you will use an API key as that token.

API keys never expire and may need to be renewed, especially if you suspect they are no longer secure. You can renew them from the OData page.

To generate an authorization key

  1. Select Administration from the navigation rail.

  2. Select Historian Data REST API.

  3. In the API Key Authentication box, select add_icon.

    The API Key Authentication box

  4. In the Add API Key dialog box, type a name for the new authorization key and select Add.

    The Add API Key dialog

    The Edit API Key dialog box displays your API key .

    The Edit API Key dialog

  5. Select copy icon gray to copy the API key to the Clipboard.

  6. Paste this as the bearer token in the authorization header of your retrieval request.

To renew an API key

  1. Navigate to Administration.

  2. Select Integration Settings.

  3. Select Historian Data REST API.

  4. To the right of the key, select 3dot_icon,and then select Edit.

  5. Select Refresh_icon.

  6. Select Renew.

    TitleResults for “How to create a CRG?”Also Available in