Introduction
To use the Flywheel CLI or SDK to interact with your Flywheel site requires creating and authenticating with an API Key. Starting with Flywheel Enterprise version 16.19.0, only Enhanced API Keys can be created, while prior versions permit creating Legacy API Keys. Use of existing Legacy API Keys will not be supported in a future major version update of Flywheel Enterprise.
Do not share your API key with anyone (not even Flywheel support staff). This key should be treated like a password used to sign into Flywheel.
Instruction Steps
Generate an API Key (Enhanced)
To use the Flywheel CLI or SDK to interact with your Flywheel site; generate an API key by following the below steps:
1. Log into Flywheel
2. In the upper-right corner, select your account menu and select Profile.
3. Scroll down to to the Flywheel Access section.
4. Click Generate API Key
5. Provide a name for your key, select its expiration date and click Add Key.
6. Copy the new key and save it securely. It will not be accessible again.
Generate an API Key (Legacy)
To start using the CLI to interact with your Flywheel site; generate an API key.
1. Log into Flywheel
2. In the upper-right corner, select your account menu and select Profile.
3. Scroll down to to the API Key section.
4. Click Generate API Key
Resources
- API Keys for Users and Devices
- Installing the Flywheel Command–Line Interface (CLI)
- Find Your Flywheel Version