How-to
Find an app's API key
Each app keeps its API key in its own settings. This table says where to find it in the apps Starboard works with. Copy the key, then paste it into API key when you add an app.
Before you begin
- The app is running and you can open its web page.
- If API keys are new to you, read What an API key is.
Where each app keeps its key
Starboard gives the apps it installs their keys for you, so you need this table only for an app you run yourself.
| App | Where the key is in the app |
|---|---|
| Jellyfin | Dashboard, then API keys. Make a new key and name it Starboard. |
| Audiobookshelf | Settings, then API Keys, signed in as an admin user. |
| qBittorrent | Options, then Web UI, API key. This needs qBittorrent 5.2 or later. |
| NZBGet | NZBGet has no key. Enter its control user name and password as user:password, from Settings, then Security, ControlUsername and ControlPassword. |
| Bazarr | Settings, then General, API Key |
| SABnzbd | Config, then General, API Key |
Apps from an existing set-up
A new install has Reelix in place of these apps. If you run them already:
| App | Where the key is in the app |
|---|---|
| Sonarr, Radarr, Lidarr, Readarr and Prowlarr | Settings, then General, API Key |
| Seerr, Jellyseerr or Overseerr | Settings, then General, API Key |
The hint under API key in Starboard also says where the key is for the kind of app you chose.
Steps
- Open the app's own web page.
- Go to the place the table names for that app.
- Copy the key. Some apps have a copy button beside it. Otherwise, select the whole key and copy it.
- In Starboard, paste the key into API key and select Test connection.
Things to note
- Jellyfin and Audiobookshelf keys are optional. Jellyfin's key adds what is playing and what was added to System. Audiobookshelf's key is needed only to copy listening progress.
- Other app has no API key. Starboard only checks that its page answers.
- With Docker access, Search for new apps can read the keys of Sonarr, Radarr, Lidarr, Readarr, Prowlarr, SABnzbd and Seerr for you. Read Search for apps already on your server.
- Treat an API key like a password. Anyone with it can control that app.
- Menu names can differ a little between versions of an app. If the key is not where the table says, try the app's general or security settings.
Find out more
This page on GitHub, where the help is written.