Powered by Zoomin Software. For more details please contactZoomin

Progress Data Platform Help

Manage API keys

  • Last Updated: November 19, 2026
  • 3 minute read
    • Documentation

API keys let applications and automated workflows connect to Progress Data Platform without a user's credentials. Create a key, assign its platform roles, and grant access to the projects it needs. For information about how roles control access, see Share access.

Before you begin

  • To manage a key's platform roles, you must be an account owner.
  • To grant a key access to a project, the key must exist, and you must be an account owner with permission to manage the platform. If you do not have the required permissions, contact your account administrator.

Create an API key

API keys are created in Progress account management, not in Data Platform.

To create an API key:

  1. Open the Account menu at the bottom of the sidebar; then, under Configuration, select NUA keys. The account management window opens in a new browser tab.

    Note: The Configuration section of the user menu is visible only to account managers.

  2. Click New Agentic Rag Understanding API Key.

  3. In the Create new Agentic Rag Understanding API Key window, provide values for the fields; then, click Save. The key's secret appears in a pop-up window.

  4. Copy the secret and store it securely. For example, in a secrets manager.

    Important: For security reasons, the secret is shown only once. After you close the pop-up window, you cannot view the secret again. If you lose it, you must create a new key.

The key is created for your account. Next, manage its platform roles and grant it access to the projects it needs.

Manage the roles of an API key

Account owners can review API keys and manage the platform roles that each key has in Data Platform.

To manage the roles of an API key:

  1. In the sidebar menu, click Settings, and then select Users & Access Control.
  2. In the API keys section, locate the key. You can search by key name or client ID.
  3. Select the key. The API Key Details panel opens.
  4. Under Platform Roles, select or clear the checkboxes for the roles that the key needs.
  5. Click Save.

The roles are updated, and the panel closes.

Note: The API keys section is visible only to account owners.

Grant an API key access to a project

Granting an API key access to a project is handled in Data Platform.

To grant an API key access to a project:

  1. Open the project.
  2. At the top of the page, click Project options, and then select Settings. The Project Settings window opens.
  3. Select Advanced.
  4. In the API Key Access Control section, under Add API keys, search for the key by name or client ID.
  5. Select the key from the search results.
  6. In the permission menu next to the search field, select Reader or Writer. The default is Reader.
  7. Click Add.

The key appears under Keys with access. The change takes effect without a separate Save action.

Grant the minimum role that the key needs. For example, a key that only reads data needs Reader access. A key that imports data into the project needs Writer access.

Troubleshooting

The following table describes common issues you might encounter when managing API keys and potential solutions.

Issue What to do
API Key Access Control is not visible. Ensure that you are an account owner with permission to manage the platform. Contact your account administrator if you need access.
Data Platform displays NUA keys are not allowed for this account. API keys are not enabled for your account. Contact your account administrator.
Alert