Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qbraid.com/llms.txt

Use this file to discover all available pages before exploring further.

Every qBraid user gets unique API keys for programmatic access. Use them with qBraid Runtime, the REST API, the CLI, or Quantum Jobs from Lab. Open the API Keys page from the sidebar under Account > API Keys.
API Keys page

​
Create an API key

1

Open API Keys

Click Account > API Keys in the sidebar.
2

Click Create API Key

The button is in the top-right.
3

Enter details

Name the key and pick any scopes if shown.
4

Confirm

Click create. The new key value is shown once.
The key value is shown only once, right after creation. Copy it immediately and store it somewhere secure. If you lose it, you’ll have to revoke and create a new one.
Creating an API key

​
View key details

1

Open API Keys

Click Account > API Keys in the sidebar.
2

Click the key in the list

The row expands inline.
You’ll see:
  • Creation date.
  • Last used date.
  • Status (active or inactive).
  • Permissions and usage stats.
API key details

​
Rotate a key

Rotation generates a new key value with the same name and permissions, and immediately invalidates the old one.
1

Open API Keys

Click Account > API Keys in the sidebar.
2

Find the key

Locate it in the list.
3

Click Refresh

The refresh icon sits next to the Copy icon on each row.
4

Confirm regeneration

Click Regenerate Key in the dialog. The new value is shown once.
Once you regenerate, the old key stops working straight away. Update every service using it before rotating, or production will break.

​
Revoke a key

1

Open API Keys

Click Account > API Keys in the sidebar.
2

Find the key

Locate it in the list.
3

Click Delete

The trash icon on the row.
4

Confirm

Confirm in the dialog.
The key is permanently removed.
Revoking an API key
Revoked keys cannot be recovered. Make sure nothing in production is still using the key before you revoke.

​
Security best practices

API keys grant access to your credits and resources. Treat them like passwords.
Every 90 days is a reasonable baseline. Rotate sooner if you suspect a leak.
Use environment variables or a secrets manager (1Password, Vault, AWS Secrets Manager, etc.).
Send via a password manager or vault link. Screenshots leak through bug reports and tickets.
Review the Last used column periodically. If a key is being used when it shouldn’t be, revoke it.
If you discover a vulnerability, report it via our security advisory form. For the full security policy, see qBraid Security Policy.