The devices page gives Site Admins the ability to create and manage API keys for devices and applications that are authorized to interact with their Flywheel instance. Device keys work similarly to user API keys but with elevated permissions.
Common use cases for creating devices in Flywheel include:
-
A managed API key that can be used by an internally developed application to send data to Flywheel
-
Giving temporary access to an external application to interact with Flywheel
This article describes how to add a new device to your Flywheel instance.
Device keys have Site-Admin level access to all groups and projects. These Devices can create, modify, and delete data throughout your Flywheel instance.
Note
Data provenance considerations
Data imported or modified using a device key will have a recorded origin of "Device." Therefore, no user ID will be associated with these actions. Care should be taken in how device keys are used when end-to-end provenance is important to a given project.
-
Sign in to Flywheel as a Site Admin.
-
Select Devices from the left-hand menu.
-
Click New Device.
-
Enter a label.
-
For Type, select Reaper or Importer.
Note
There is no functional difference between these types.
-
Click Add.
-
The device appears in the list of devices with the API key.
On existing devices, you can:
-
View the device key
-
Revoke and generate a new device key
-
Disable a device
Warning
Regenerating a device key or disabling a device will permanently revoke its current device key. Re-enabling a device will generate a new device key. Any entity using the device key will need to re-configured with the new device key to continue operating as expected.