Create and protect API keys

API keys authenticate a person, AI client, script, or service to one Signaliz workspace. Create a separate key for each connection so activity can be audited and access can be rotated without breaking everything else.

Create a key

Open Settings → Connect → API keys.
Choose Create key.
Use a descriptive name such as Claude desktop — Josh or production enrichment worker.
Select the smallest scopes the connection needs.
Copy the secret immediately and store it in a password manager or secret store.

The full secret may only be shown once. Signaliz displays a masked identifier later so you can recognize the key without exposing it.

Use the key

For REST, send it as a Bearer token:

Authorization: Bearer YOUR_SIGNALIZ_API_KEY

For the CLI, use signaliz auth login or set SIGNALIZ_API_KEY in the process environment. For private MCP clients, use the keyed URL shown in Settings → MCP setup.

Rotate a key

Create a replacement, update the intended client, test one read or dry run, then revoke the old key. Never paste a production key into a help ticket, article, screenshot, source file, or chat message.

If a key is exposed, revoke it immediately and create a new one. A masked prefix is an identifier, not a usable credential.