Skip to main content

API Keys

API keys are service credentials for your own automation. API key management requires a user token. An API key cannot create, reveal, list, or delete API keys. Open the API Keys tab in Breezy to manage service API keys from the dashboard.

Management flow

  1. Authenticate with a user JWT.
  2. POST /integrations/api-keys to create a key.
  3. Store the returned key immediately. It is shown only once and is secret.
  4. Use Authorization: Bearer bzy_live_... for server-to-server requests.
  5. Rotate and delete unused keys with the management endpoints.

Safety expectations

  • Store keys only in a secret manager or equivalent encrypted configuration.
  • Do not log full key values.
  • Prefer one key per integration or automation owner.
  • Delete keys immediately when an integration is retired.