API keys
Generate and use Parix API keys for database and TigerBeetle API calls.
API keys are managed from the global settings route, not from an organization-scoped URL:
/settings/api-keys
/settings/api-keys/generateThe generated secret is shown once. Store it in your application environment:
export PARIX_API_KEY="px_..."Scopes
The current key model supports:
- all-databases keys for organization-wide operations
- specific-database keys for one database
API keys authenticate to the API with db:read and db:write scopes. Read TigerBeetle operations require db:read; write TigerBeetle operations and database creation require db:write.
| Goal | Recommended scope |
|---|---|
| Create or list databases for an organization | All databases |
| Connect one application to one database | Specific database |
| Run read-only verification commands | Specific database with read access |
| Run TigerBeetle create operations | Scope that includes write access to the target database |
Headers
Use the x-api-key header:
curl "https://dev.parix.io/api/v1/databases/<database-id>" \
-H "x-api-key: $PARIX_API_KEY"The API authentication layer also accepts bearer credentials for supported CLI and OAuth flows:
Authorization: Bearer <token-or-api-key>Key table
The dashboard table shows key name, masked key value, status, scope, creation time, last-used time, and actions. The key secret cannot be retrieved again after generation.
For common failures, see API keys and authentication.