Skip to main content

API keys

API keys authenticate SR-Bridge and approved machine integrations. They are tenant-specific credentials and should be handled like passwords.

Create a key​

  1. Open Integration > API Keys with the required administrative permission.
  2. Create a key with a name that identifies its system, environment, and owner.
  3. Copy the credential directly into the approved secret/configuration store.
  4. Test it against the intended tenant and environment.
  5. Record the owner and rotation date without recording the secret itself.

Safe operation​

  • Use different keys for development, QA, and production.
  • Never place a key in documentation, screenshots, email, source control, or support tickets.
  • Rotate a key after staff changes or suspected exposure.
  • Remove keys that no longer have an active integration owner.
  • If regeneration replaces a credential, update every dependent bridge before disabling the old value.

Use Integration Logs to diagnose a request; do not expose the credential to prove which key was used.