How to create an API key
If you need to connect an external system to DevSphere OS, an admin can create an API key that authenticates read access to your organization's data.
#When to use this
Use this when integrating an external tool or script that needs to read your leads or invoices.
#Step by step
1
Open API keys
An admin opens Settings and goes to the API keys area.
2
Create a key
Enter a clear name and choose the scopes the integration needs (for example, leads:read).
3
Copy the secret once
The key begins with dvs_live_ and is shown only one time. Copy it right away.
4
Store it safely
Keep the key in a secure secrets manager — it cannot be shown again.
5
Use it to authenticate
Send the key as an Authorization: Bearer header when calling the API.
#Expected result
What you should see
You have an API key that authenticates requests to the DevSphere OS API, with the secret stored securely.
#Common mistakes
- Closing the screen before copying the one-time secret.
- Choosing more scopes than needed.
- Sharing one key across many integrations.
#Troubleshooting
| If this happens | Try this |
|---|---|
| I lost the secret | It cannot be shown again — rotate the key (or create a new one) to get a fresh secret. |
| Requests return 401 | The key is wrong, revoked, or expired; reissue it. |
#Best practices
- Use least-privilege scopes.
- One key per integration.
- Store keys in a secrets manager, never in code.
Still need help?
Can’t find what you’re looking for? The DevSphere OS team is happy to help.
Was this page helpful?