API keys

Use API keys with qBraid Runtime, the REST API, and the CLI.

Create a key

Select the intended workspace.
Open Account > API Keys.
Select Create API Key.
Enter a name and, optionally, a description.
Choose 30, 60, or 90 days, Never expire, or a custom number of days.
Create the key and copy its secret value into your password manager or secrets store.

The secret value appears only after creation or regeneration. If you lose it, regenerate the key or create a replacement.

The creation form does not provide a scope selector. Use the key details to inspect the permissions associated with a key.

Inspect a key

Select a key in the table to open its detail dialog. The table shows status, creation date, last use, and expiration. Details can include the last IP address, rate limit, permissions, constraints, and revocation information.

Keys belong to the selected workspace. Switch workspaces if the key you expect is not in the list.

Rotate a key

Select the key’s Regenerate control and confirm the dialog. Copy the new secret when it appears.

Regeneration invalidates the previous secret. Update the applications that use it immediately. For a planned migration, create a separate replacement key, update and verify your applications, then revoke the old key.

Revoke a key

Select the key’s Revoke control and confirm. Revocation prevents further use of that key. Check that your applications have a working replacement before revoking a key they still need.

Keep secret values out of source control, screenshots, and support requests. Review last-used information when investigating unexpected access. Report vulnerabilities through the qBraid security advisory form.