Admin Reference
API Keys Route Reference
Understand scoped API key creation, one-time plaintext reveal, and the legacy redirect into Connected Systems.
Before you start
- You need machine credentials for automation or external-system access.
Expected outcome
You can create and revoke keys safely and understand where the working key-management desk now lives.
What this route is for
API Keys is the legacy entrypoint for machine credentials used by integrations, automation, or external system access.
Visibility and route behavior
| Item | Details |
|---|---|
| Route id | api-keys |
| Current behaviour | Redirects into #/connected-systems?section=api-keys. |
| Visibility | Customer-facing when connected-system access is enabled. |
| Direct inbound | Older shell links, bookmarks, and Connected Systems context. |
Main regions, dialogs, and controls
| Surface | What it does |
|---|---|
| API key table | Lists existing keys with prefix, scopes, created date, and expiry. |
| Create dialog | New key with name, scopes, and optional expiry. |
| Detail dialog | Shows metadata and reveals the plaintext secret once. |
| Revoke flow | Removes a key from active use. |
| API docs link | Opens /api-docs for consumer guidance. |
Key actions
- Create a new scoped key.
- Choose expiry such as 30, 90, 365 days, or no expiry.
- Copy the plaintext key at creation time.
- Review scope, expiry, and prefix later.
- Revoke a key that should no longer be trusted.
Filters and URL state
| Param | What it controls |
|---|---|
keyId | Open detail context |
create | Opens create mode |
- The working desk now lives inside Connected Systems, so the most important state is the destination section rather than a standalone workspace.
Outputs and side effects
- Creates live machine credentials.
- Reveals the plaintext secret only once after creation.
- Revoking a key immediately affects any external automation that still depends on it.
Inbound links
- Legacy
#/api-keysbookmarks or shell entrypoints. - Connected Systems
api-keystab.
Outbound links
- Redirect to
#/connected-systems?section=api-keys - External
/api-docs
Indirect handoffs
- Key hygiene here directly affects whether external tools can continue to access Deucalion safely.
- Scope choices determine how much downstream record access external automation will have.
Troubleshooting
| Symptom | What to check |
|---|---|
| The key secret is no longer visible | That is expected. Plaintext reveal is a one-time action. |
| A standalone link seems to jump away | That is expected because the active desk now lives in Connected Systems. |
| Automation suddenly fails after a revoke | Confirm the external system was not still using the revoked key. |