On this page
What an API key is
An API key is a long secret code that one app gives another, so the second app can talk to it. It is like a copy of your house key for someone you trust. They can let themselves in without your password, and you can change the lock if you need to.
What API means
API stands for application programming interface. It is the way apps talk to each other, rather than to people. When you use Jellyfin, you use its web page. When Starboard uses Jellyfin, it skips the page and asks Jellyfin's API questions directly, such as "what is playing?" or "what was added today?".
Why an app needs a key
Your apps do not answer anyone who asks. Before Jellyfin answers Starboard, it checks that Starboard has Jellyfin's API key. Without the key, Jellyfin says no.
Each app makes its own key. A key is usually a jumble of about 32 letters and numbers, such as 0a1b2c3d4e5f
and so on. Never share your real keys in a message or online.
Where to find a key
Starboard gives the apps it installs their keys for you. For an app you run yourself, each app keeps its API key in its own settings. In Jellyfin, it is in Dashboard, then API keys. Other apps keep it elsewhere. Read Find an app's API key for every app Starboard works with.
Keep keys safe
An API key gives control of the app it belongs to, so treat it like a password:
- Paste it only into apps you trust, such as Starboard.
- Do not post it in a forum, a chat or a screenshot when you ask for help.
- If a key gets out, make a new one in the app. The old key stops working. Then paste the new one into Starboard.
What this means for Starboard
Starboard needs an API key for most apps before it can show their queues, calendars and warnings, or add films and series to them. When you add an app, Starboard asks for its key and says where to find it.
The keys you give Starboard stay on your server, in a file only you can read. They are never sent to your browser.
Starboard's own API keys
Starboard has an API of its own, for other apps, scripts and AI assistants that read Starboard. Its keys are different from your apps' keys: you make them in Settings, Security, under API keys, and each one can only read. Read Make an API key and use Starboard's API.
Find out more
This page on GitHub, where the help is written.