Creating a New Key #
- Navigate to DDLS > Developer > API Keys.
- Click Add New.
- Fill in the following fields:
| Field | Required | Description |
|---|---|---|
| Name | Yes | A descriptive label (e.g., “Production Sync Service”) |
| Scopes | Yes | Individual scopes or a scope template (read-only, full-access, admin) |
| Expiry | No | Optional datetime after which the key will no longer authenticate |
| IP Whitelist | No | Comma-separated list of IPv4 or IPv6 addresses or CIDR ranges (e.g., 192.168.1.0/24, 10.0.0.1) |
| Rate Limit Override | No | Override the default tier for this key with a specific requests-per-hour limit |
- Click Create API Key.
- Copy the displayed key immediately. The full key is shown only once. After navigating away, it cannot be recovered.
Managing Existing Keys #
From the API Keys list screen, you can:
- View usage statistics: The
last_used_attimestamp shows when the key was last used to authenticate a request. - Edit: Modify the key’s name, scopes, expiry, IP whitelist, or rate limit override without changing the key itself.
- Revoke: Immediately disables the key. The key record is preserved in the database (for audit trails). Revoked keys return HTTP 401.
- Delete: Soft-deletes the key (sets
status=deleted). The record is preserved. Deleted keys return HTTP 401.
Revoke vs. Delete #
| Action | Effect | Record Preserved |
|---|---|---|
| Revoke | Key is immediately rejected at authentication | Yes |
| Delete (soft) | Key is immediately rejected at authentication | Yes |
Both actions are reversible only by creating a new key. The original key value cannot be unrevoked or recovered.
