Skip to main content

​
API keys

Use API keys to authenticate your app or backend when calling Flywheel APIs.

​
Open API key settings

  1. Go to Settings → API in your workspace.
  2. Use Generate API Key to create a new key.

Open API Settings

Go directly to your workspace API key settings.

​
Create a new API key

When you click Generate API Key, Flywheel opens a dialog where you:
  1. Enter a descriptive key name (for example: production-events-writer)
  2. Click Create API Key
  3. Copy the key immediately
The full key value is shown once at creation time. Store it in your secret manager before closing the dialog.

​
Manage existing keys

In Settings → API, Flywheel lists your existing keys with:
  • Name
  • Created date
  • Redacted key value
You can delete a key from the row actions menu.

​
Use your key in API requests

Flywheel APIs use header-based authentication: 
Authorization: YOUR_API_KEY
Auth-Type: api
The same authentication format is used throughout the API reference pages.

​
Best practices

  • Create separate keys for each environment (dev/staging/prod).
  • Use descriptive names so teammates know where each key is used.
  • Rotate keys periodically.
  • Delete keys you no longer use.