On this page
What the API covers
Every page action in Starboard, and how another app, a script or an AI assistant reaches it: an address in the API with the right a key needs, an action kept for a person signed in to Starboard, or one not in the API yet. Use it to find out whether what you want to build is possible with a key, and which right and scope to give that key.
- read: any key with the scope. manage: a key made with Read and manage. Read Authentication and keys.
- Signed in only: a person must do it in Starboard. These actions change settings, keys, plug-ins or the install, call an address someone types, use a password, or could lock the owner out, so no key can do them.
- Not yet: possible later, as its own decision.
Every address starts with /api/v1. The API reference gives each one in full.
Apps
| What a person can do | In the API | Right and scope |
|---|---|---|
| Read each app, whether it answers, and its problems | GET /apps, /apps/{id}, /status, /health |
read, apps |
| Read uptime, counts from each app and app updates | GET /uptime, /numbers, /app-updates |
read, apps |
| Read containers and versions; check for newer images | GET /containers; POST /containers/check |
read and manage, apps |
| Update an app, one at a time, with a way back when it does not run | POST /updates with app:<id> or reelix |
manage, updates, only when ticked |
| Add, edit, test, find or remove an app; copy settings | Signed in only: it stores app keys and calls the address entered | |
| Reorder apps and categories | Not yet |
Downloads, requests and Coming up
| What a person can do | In the API | Right and scope |
|---|---|---|
| Read the queue, speeds and Reelix's history | GET /downloads, /transfer, /history |
read, downloads |
| Copy the downloads that need attention or failed, with their details, for an AI helper | GET /downloads/issues |
read, downloads |
| Remove, block, or block and search again | POST /downloads/actions |
manage, downloads |
| Read download hours; resume, pause or follow them | GET /download-hours; POST /download-hours |
read and manage, downloads |
| Read requests; approve or decline | GET /requests; POST /requests/{id}/approve, /decline |
read and manage, requests |
| Read Coming up, as a list or a month | GET /calendar, ?month= |
read, media |
| Search the apps and add to one | Not yet |
Library and media
| What a person can do | In the API | Right and scope |
|---|---|---|
| Read the Library's counts and recently added; search it | GET /library, /library/search |
read, library |
| Read each tab's index; build a tab again | GET /library/status; POST /library/refresh |
read and manage, library |
| Read recently added and what is playing | GET /recent, /playing |
read, media |
| Read the Jellyfin and Audiobookshelf jobs; run one now | GET /extras; POST /extras/{name}/run |
read and manage, media |
| Add a title to Reelix, change or delete one, saved views | Not yet | |
| Import watch history or listening progress from an address | Signed in only: it calls the address entered |
System
| What a person can do | In the API | Right and scope |
|---|---|---|
| Read processor, memory, disks and their history | GET /system, /system/history |
read, system |
| Read the version and the newest release | GET /version |
read, system |
| Send a test alert | POST /alerts/test |
manage, system |
| Events as they happen: apps down and up, alerts, new items, finished downloads, playback | GET /events |
read, by each event's scope |
| Read Starboard's log, with addresses, names and keys taken out | GET /logs |
read, logs, only when ticked |
| Read the log limits, what the logs take now and the apps' own limit from Docker | GET /logs/limits |
read, logs, only when ticked |
| Change the log limits (days and size) | POST /logs/limits |
manage, logs, only when ticked |
| Delete all logs | POST /logs/delete with {"confirm": true} |
manage, logs, only when ticked |
| Jobs, storage, disk health and the pool | Not yet | |
| Back up, restore, the pool's plan, server jobs | Signed in only: they need the password or run as root |
Settings and security
| What a person can do | In the API | Right and scope |
|---|---|---|
| Change General, Alerts, Performance or Jellyfin settings (apart from the log limits, in System) | Signed in only | |
| Make or revoke API keys; add or remove plug-ins; update a plug-in from an address | Signed in only | |
| Password, Sign out everywhere, who can open the dashboard | Signed in only | |
| Reelix's settings, editions and moving apps into Reelix | Signed in only: they use Reelix's admin password | |
| Your install, Install apps, taking over and rolling back | Signed in only: they change what runs on the server | |
| Reset the password; go back to an older Starboard | On the server only, with ./reset-password.sh or ./update.sh --to |
Updates
| What a person can do | In the API | Right and scope |
|---|---|---|
| Read what can be updated: Starboard, Reelix, the other apps and the plug-ins | GET /updates |
read, updates, only when ticked |
| Update Starboard to the newest release (Update now) | POST /updates with starboard |
manage, updates |
| Update a plug-in to the version a catalogue lists | POST /updates with plugin:<id> |
manage, updates |
| Follow an update step by step, and find out how it ended | GET /updates/runs, /updates/runs/{id} |
read, updates |
| Roll a plug-in back to the version before | POST /updates/rollback with plugin:<id> |
manage, updates |
| Install updates automatically, and when | Signed in only: it is a setting |
Find out more
This page on GitHub, where the help is written.