Skip to content

API keys

API keys belong to your organization and are managed on the dashboard's API Keys page. Every key starts with rf_live_ and is sent as the Yellowstone x-token (authentication).

What a key reaches#

A key you create works on every server behind every active subscription your account holds: one key can stream from Shared gRPC in one region and from a dedicated instance in another. When a subscription ends, its servers stop accepting your keys; the keys keep working everywhere else.

Managing keys#

On the dashboard's API Keys page:

  • Create a key with a name, or let the dashboard pick one. Give each service or machine its own key, so you can rotate or revoke one without touching the rest.
  • Rename a key at any time; the secret does not change.
  • Rotate a key to issue a new secret. The old secret stops working at once, with no overlap, so deploy the new one straight after.
  • Revoke a key to remove it from every server.

Keep keys out of repositories and front-end code. If one leaks, rotate it.