aware

Settings — API Keys

API Keys are long-lived authentication tokens used by external systems, integrations, or scripts to authenticate against the AwareVue API without a user password. Each key is shown in full exactly once — immediately after creation — and can be revoked at any time.

Security notice: The full API key value is only displayed once, right after creation. If you close the dialog without copying the key, it cannot be recovered. You will need to revoke the key and create a new one.

Create API Key

Clicking + (requires api-key:create) opens the New API Key dialog:

Field	Description
Display Name	Required — a label identifying the key’s purpose (e.g. “CCTV integration”)

After saving, the full key value is shown in a read-only field with a Copy to clipboard button. Copy it immediately and store it securely.

Key List

Each row shows:

Display Name
Key prefix (first few characters + masked remainder) and creation date
Revoke button

Revoke an API Key

Clicking Revoke (requires api-key:revoke) opens a confirmation before permanently invalidating the key. This cannot be undone.

Permissions

Action	Permission
View API keys	`/settings/api-keys` route
Create API key	`api-key:create`
Revoke API key	`api-key:revoke`

← Back to Settings