On this page
- Two version numbers
- Starboard API 1.6.0 (Starboard 0.20.0), 16 November 2026
- Starboard API 1.5.0 (Starboard 0.20.0), 16 November 2026
- Starboard API 1.4.0 (Starboard 0.20.0), 16 November 2026
- Starboard API 1.3.0 (Starboard 0.19.0), 15 November 2026
- Starboard API 1.2.0, 14 November 2026
- Starboard API 1.1.0, 13 November 2026
- Plug-in API 1.15.0 (Starboard 0.19.0), 15 November 2026
- Plug-in API 1.14.0 (Starboard 0.18.0), 14 November 2026
- Plug-in API 1.13.0, 13 November 2026
- Plug-in API 1.12.0, 13 November 2026
- Plug-in API 1.11.0, 13 November 2026
- Plug-in API 1.10.0, 13 November 2026
- Plug-in API 1.9.0, 13 November 2026
- Plug-in API 1.7.0, 13 November 2026
- Plug-in API 1.5.0, 12 November 2026
- Plug-in API 1.6.0, 12 November 2026
- Plug-in API 1.4.0, fixes, 12 November 2026
- Starboard API, description 1.0.0 again, 12 November 2026
- Plug-in API 1.4.0, 12 November 2026
- Plug-in API 1.3.0, 12 November 2026
- Plug-in API 1.2.0, 12 November 2026
- Plug-in API 1.1.0, 11 November 2026
- Starboard API, description 1.1.0, 11 November 2026
- Starboard API 1.0.0, 10 November 2026
- Plug-in API 1.0.0, 10 November 2026
- Find out more
API changelog
What changed in Starboard's API and in the plug-in API, newest first. Each entry is tagged Added, Changed, Deprecated, Removed, Fixed or Security. Within version 1, changes only add: nothing you rely on is taken away without warning. A field that will go is marked deprecated first and removed no sooner than 6 months later, in the next major version.
Two version numbers
- Starboard's API (
/api/v1): its description,starboard/openapi.json, hasinfo.version, andGET /api/v1/answersapi_version. - The plug-in API:
API_VERSIONinstarboard/plugins.py. A plug-in names the versions it works with instarboard_api. Read What each API version added.
Starboard API 1.6.0 (Starboard 0.20.0), 16 November 2026
- Added:
GET /backup/copies, with thesystemscope and a read key: where copies of full backups go off this computer (another disk, a share or a cloud service), how many are kept there, the last copy and the last Test connection. Never a password, key or rclone config. Read the API reference. - Added:
POST /backup/copies/test, with thesystemscope and a manage key: Test connection, as the button on Settings, General, Backup and restore. It reaches the place, writes a small file, reads it back, removes it and checks there is room for the newest backup, in 2 minutes at most, and keeps the result.409 not_set_upwhen no place is set up,409 cannot_testwhen a test is already running. Anerrorthat startsSIGNIN|means a cloud service no longer accepts the sign-in. - Nothing was taken away: every earlier address answers as before.
Starboard API 1.5.0 (Starboard 0.20.0), 16 November 2026
- Added: Install all updates, for keys that ticked
updates:GET /updates/allsays what would install, in the order it runs (the other apps, Jellyfin's plug-ins, Starboard's plug-ins, Reelix, then Starboard last), and what is held back withwhy(a plug-in asking for new permissions or that comes as a zip file, a new major version, or anything Starboard cannot update from here). With a manage key,POST /updates/allstarts them as one batch, one at a time, each with its own copy, check and way back; send{"targets": [...]}to run only the ones you showed someone. It answers 202 with the batch's run, whichGET /updates/runs/{id}follows: its steps are the updates, with the stateswent-backandheldtoo, and the batch endsupdated,some-updated,went-backorfailed. Read the API reference. - Added:
big_changeon apps and Reelix inGET /updates. - Nothing was taken away: every 1.4.0 address answers as before.
Starboard API 1.4.0 (Starboard 0.20.0), 16 November 2026
- Added: the log limits, for keys that ticked
logs:GET /logs/limitssays how long Starboard keeps its logs (keep_days, 30 by default), the most they may take together (max_mb, 50 by default), what they take now, what the limits cover, and the apps' own limit read from Docker (apps). With a manage key,POST /logs/limitswith{"keep_days": 14, "max_mb": 25}changes them, from the same choices as the page, and older days go at once. Read the API reference. - Added:
POST /logs/deletewith{"confirm": true}and a manage key that tickedlogs: Delete all logs, as on Settings, General, Logs and feedback. Today's file and the audit log are emptied, not removed, and the first new line says which key deleted them. - Changed: a manage key with
logsmay change these two settings and delete the logs, the second exception to "a key never changes settings" afterupdates. A key with no scopes still has neither. - Nothing was taken away: every 1.3.0 address answers as before.
Starboard API 1.3.0 (Starboard 0.19.0), 15 November 2026
- Added:
GET /downloads/issues, with thedownloadsscope and a read key: every download in the queue that needs attention or failed, with its app, download client, the app's own state, every message, size, progress, age, indexer, paths inside the container, the ids in Reelix or the app, the download client's ids and what Starboard already tried.markdownholds the same as Markdown, with a short prompt at the top for an AI helper. Each app's queue is asked only when you call it, at most every 10 seconds. Keys, passwords, tokens, private addresses and full download addresses are taken out. Read the API reference. - Fixed: an update run's
kindinGET /updates/runscan bejellyfin-plugins(Jellyfin's own plug-ins updated by Starboard, DASH-422), which the description now lists. - Nothing was taken away: every 1.2.0 address answers as before.
Starboard API 1.2.0, 14 November 2026
- Added: updates, for keys that ticked the new
updatesscope (a key with no scopes does not have it, as withlogs):GET /updateslists what can be updated (Starboard, Reelix, the other apps and the plug-ins) from what Starboard already knows, with the update running now;POST /updateswith{"target": "plugin:direct-play"}starts an update to the newest version Starboard knows, and answers202with the run;GET /updates/runsandGET /updates/runs/{id}give each update's steps and how it ended;POST /updates/rollbackrolls a plug-in back to the version kept before. Read the API reference. - Added: each update has the same backup, health check and way back as on the pages, and
update_startedandupdate_finishedlines in the audit log as well as theapi_writeline. One update runs at a time. Never from an address the key gives. - Added: the errors
update_runningandcannot_update, both409. - Changed: the API reference says that
logsandupdatesare only for keys that ticked them. - Nothing was taken away: every 1.1.0 address answers as before, and a key made before keeps what it had.
Starboard API 1.1.0, 13 November 2026
- Added: reads for the rest of the pages:
/calendar(with?month=),/requests,/transfer,/download-hours,/history,/library,/library/search,/library/status,/uptime,/app-updates,/numbers,/containers,/version,/system/historyand/extras. - Added: the
manageright (Read and manage, keyssb_manage_...) and the everyday actions, each aPOST:/downloads/actions,/download-hours,/requests/{id}/approveand/decline,/library/refresh,/containers/check,/alerts/testand/extras/{name}/run. A read key gets403right_needed. Bodies are JSON of up to 64 KB,Idempotency-Keymakes a retry safe, and every change is in the audit log. - Added:
/events, Server-Sent Events: apps going down and coming back, alerts, new items, finished downloads and playback starting, each heard only by keys whose scopes cover it. - Added: the scopes
libraryandrequests, and scopes and the right chosen in Make a key. - Added:
/logs, Starboard's log with addresses, names and keys taken out, for thelogsscope only: a key with no scopes does not read it. For AI assistants, read Connect an AI assistant. - Added: each write in the description has
x-right: manage; the errorsnot_set_up,app_failed,too_largeandtoo_many_streams. - Changed: a
Linkheader for the next page keeps the other query parameters, such aslimit. - Nothing was taken away: every 1.0.0 address answers as before, and a read key works as it did.
Plug-in API 1.15.0 (Starboard 0.19.0), 15 November 2026
- Added:
buildon a container (DASH-414): its image is built by Starboard from theDockerfilein the plug-in's zip file and taggedlocal/<id>:<version>, for a private plug-in with no registry, such as On demand. Installed with Settings, Plug-ins, Add a plug-in, Upload a zip file, and updated with Update from a zip file on its page; Roll back works as for any plug-in. The zip and the Dockerfile are checked first, and the build runs with limits (2 GB of memory, 2 processor cores, 20 minutes, an image of up to 3 GB). Read Built from a zip file. - Added:
jellyfin_librariesand the permissionjellyfin:libraries(medium risk, DASH-430): Jellyfin libraries for folders the plug-in fills, which Starboard adds on each activation with real-time monitoring deactivated unless the plug-in setsrealtime_monitor, and keeps that way. Read Jellyfin libraries. - Changed: a manifest with
buildfrom an address or a catalogue is refused, with words that point to the zip. - Added: the permission
library:holding(high risk) with the volumemedia:holding: the media folder, read and write, at/media, so a plug-in can move films and series into the holding folder inside it,media/.holding/<plug-in id>/, keeping the folders each was in, and put them back. A container that mounts it may run as"user": "media". Read The holding folder in the media folder. (DASH-406, for Library clean-up) - Added:
restorein a custom setting item'sactions, drawn as a Put back button on the row and sent as{"action": "restore", "id"}. (DASH-406) - Added:
titleson a card (DASH-443): a title for each card size (small,medium,half,wide,full), each the card's heading on its own, on one line, at that size; the plug-in's name follows it for screen readers. Each is limited to what fits on one line in that size: small 17, medium 28, half 22, wide 43 and full 45 characters. A longer title is refused by the manifest check and named by the plug-in tester. A size left out shows the plug-in's name with the card'stitle, as before. Read A title for each size. - Changed: on a small card the band's status chip shows only its icon; its words are still read to screen readers.
- Nothing was taken away: a plug-in made for 1.14 works as before.
Plug-in API 1.14.0 (Starboard 0.18.0), 14 November 2026
- Added: a card's own refresh time,
refresh_seconds, from 10 to 3600 seconds, in the manifest and in the card's answer, which wins, so a plug-in setting can change it. 10 seconds is the quickest: a smaller value in an answer is raised to 10, and one in a manifest is an error. Read How often a card is asked. - Added: the dashboard asks cards due at the same time in one request, and nothing while the tab is hidden.
- Added:
recommendedon an entry in Starboard's own catalogue, shown in Recommended at the top of the Catalogue with a chip. Adding stays a choice, with what it may do and the password. - Added:
logo(DASH-428): a small SVG or PNG beside the manifest, withalt, checked and cleaned by Starboard (SVG up to 16 KB with no scripts, styles, pictures, event handlers or outside links; PNG square, 32 to 256 pixels, up to 32 KB) and shown in Manage, the Catalogue, the plug-in's page and its cards. Without one, its initials. A catalogue entry may carry it aslogo(a data address) andlogo_alt. Read Logo. - Added: the card band (DASH-428, design 2): every plug-in card has a grey band with the logo, the plug-in's name
as the heading, and a status chip and when it last updated, from
status,status_labelandupdatedin the card's answer. Read The card band. - Added: a job on a schedule from the plug-in's settings (DASH-432): a setting of type
schedule(every day, every week on a day, or every month on a date, at a time) andscheduleon a job naming it. Shown in System, then Jobs, with when it runs next and Run now. Read A job on a schedule from its settings. - Added: the permission
jellyfin:metadata(medium risk) and the volumesjellyfin-metadataandjellyfin-metadata:ro: Jellyfin's metadata folder at/metadata, mounted only when granted, and"user": "media"with it. Read Jellyfin's metadata folder. - Added:
update(DASH-424): abeforestep on the installed version and anafterstep on the version running at the end, each aPOSTwith a time limit of 5 to 300 seconds; a failingbeforestops the update with nothing changed.health_wait_seconds(10 to 600, 60 by default): after every update Starboard waits for the new version'shealthpath, and goes back to the version before by itself when it does not answer.migrations:rename,removeand newdefaultsfor saved settings, by version, kept for Roll back. Read Updates and Write a plug-in that updates safely. - Added: What is new since the installed version, from the new version's
changes, in the warning before an update, with the settings that move and how the update is kept safe. - Changed: an update and a Roll back run as steps in a dialog, followed with
GET /api/updates/runs/{id}/jobon Starboard's own pages;POST /api/plugins/{id}/updateand/rollbackanswer with the run. - Changed: the plug-in tester warns when
changeshas nothing for the manifest's own version, and gives a tip when a plug-in with jobs has nobeforestep. - Changed: the plug-in tester reports a logo that fails its checks, a
statusStarboard does not know in a card'sexample, and suggests a logo and a status where there is none. - Changed:
GET /api/pluginsandGET /api/plugins/cards(Starboard's own pages) give each plug-in'slogo,{url, alt}ornull;GET /api/plugins/{id}/logoserves the cleaned copy; a card's answer hasasked. The public/api/v1did not change. - Nothing changed for a card without
refresh_seconds: it is asked once a minute, or everyrefresh_minutes. - A plug-in without
updateis updated as before, with one addition: when it has ahealthpath, Starboard waits up to 60 seconds for it after the update, and goes back by itself if it does not answer. - Nothing was taken away: a manifest that worked with 1.13 works the same, and its cards gain the band with its initials and when Starboard last asked it.
Plug-in API 1.13.0, 13 November 2026
- Added: app plug-ins (DASH-411), a whole app kept out of the main install, such as Jellystat with its database. Read App plug-ins.
- Added: the permission
network:port, andpublishon thelannetwork withhost_port: the app's own web page on the home network, at a port Starboard chooses and keeps. - Added:
{secret:<name>},{jellyfin:url}and{jellyfin:key}inenv;tmpfs;data:<path>,data/<folder>:<path>andmedia/<one folder>:roinvolumes;pidsinresources, up to 1024. - Added:
adopt, which copies an app the main install already runs into the plug-in, never moving or changing its folders. - Added: removing a plug-in asks where its folder goes: kept in
data/plugins/.removed, or the holding folder. - Added:
restin a catalogue entry, the memory and processor an app uses at rest. - Changed:
envnames may have lower case letters, such asserverIP. - Nothing was taken away: a manifest that worked with 1.12 works the same.
Plug-in API 1.12.0, 13 November 2026
- Added:
"user": "media"on a container that mounts amedia/<one folder>volume: it runs as the media folder's owner (the apps' user from Install apps), so the files it adds are the person's own. Starboard makes eachmedia/<one folder>that is missing, owned by the user the container runs as; a folder that is there already is left as it is. People read that it runs as the media folder's owner before they add it. Read Containers. - Added:
linkon a custom setting's item,{"url", "label"}: a link that opens in a new tab, such as a search for the title on another site. Onlyhttpandhttpsaddresses are kept. Read Custom pages. - Added:
state_labelon a custom setting's item: the plug-in's own words for its state, such asAdded, in place of Works or Not answering, in the state's colour. - Added:
file_onlyon a custom setting'sadd: only the file picker is shown, for a plug-in that takes files and never an address. - An older Starboard refuses
"user": "media", so setstarboard_apito>=1.12when you use it. It ignoreslinkandfile_only(it shows the add box's address field too).
Plug-in API 1.11.0, 13 November 2026
- Added: four events, each from a check Starboard already makes every 5 minutes:
request.available(withmedia:read),download.failed(withdownloads:read),disk.nearly_full(withsystem:read) andupdate.available(withapps:read). Read Events. - Added:
readonlyon a custom setting's list with"layout": "folds": tables to read, with no tick boxes, states or buttons. Read Tables to read only. - An older Starboard refuses a manifest that lists the new events, so set
starboard_apito>=1.11when you use them. It ignoresreadonly.
Plug-in API 1.10.0, 13 November 2026
- Added:
changes, an optional list of the plug-in's own changes by version, in Keep a Changelog's types (added,changed,deprecated,removed,fixed,security). After an update, a Roll back or an update from an address, the plug-in's State shows What is new with the changes between the two versions, until someone chooses Got it. Nothing is fetched: Starboard reads them from the manifest it already has. Read Changes. - A plug-in without
changesstill works. Its State shows the catalogue's line about the version, or says its maker did not list what changed. - An older Starboard refuses a manifest with
changes, so setstarboard_apito>=1.10when you use it.
Plug-in API 1.9.0, 13 November 2026
- Added:
publishon a container withnetwork: vpnand aport. Starboard puts that port on Gluetun, so the home network can reach the container, and restarts Gluetun once when the plug-in starts. Use it only when something outside the server must open the container's address, such as a TV app that plays a stream address Jellyfin hands it. Read Containers. - An older Starboard refuses a manifest with
publish, so setstarboard_apito1.9when you use it.
Plug-in API 1.7.0, 13 November 2026
- Added: a custom setting's list may have sub menus:
menus, each with aparentfor the level it opens from, andmenuon each item and switch. Read Sub menus. - Changed: Test all shows only on a list whose items can be tested, or that has none yet.
- Changed: a plug-in's State says its version, for plug-ins built into Starboard too.
- Nothing in the manifest changes, so
starboard_apican stay as it is. An older Starboard leavesmenusout and shows every item in one list.
Plug-in API 1.5.0, 12 November 2026
- Added: a setting may have a
group. Each group is its own section of the plug-in's page in Settings. - Added: a choice may be
{"value": ..., "label": ...}, so people choose by name.settings.jsonstill holds the value. - Changed: the plug-in's page follows Starboard's settings patterns. Numbers save as soon as they change, the plug-in's buttons are in an Actions section, and nothing shows a toast for a saved setting.
- A manifest that uses either needs
">=1.5 <2.0"instarboard_api. An older Starboard refuses it.
Plug-in API 1.6.0, 12 November 2026
- Added: the
reelix:keypermission, with Reelix's address and key in/run/starboard/reelix.json. - Added: the
usenet:serverspermission, with the active news servers from NZBGet or SABnzbd in/run/starboard/usenet.json. Both are high risk and shown as new in an update's warning.
Plug-in API 1.4.0, fixes, 12 November 2026
- Fixed: what a plug-in reads comes as the folder
/run/starboard, readable by any container user. Before, only a container running as Starboard's own user could read it, and a running plug-in kept the settings it started with. Older plug-ins change over when Starboard starts. - Fixed: a button without an
idruns. It is known by its place in the list. - Fixed:
healthis asked by Starboard for every plug-in, not only those built into Starboard. - Fixed:
start: when_neededandidle_stop_minuteswork, for the first container. Read Resting when idle. - Added: Update from an address on a plug-in's own page, in Versions.
Starboard API, description 1.0.0 again, 12 November 2026
- Fixed: the description's
info.versionis 1.0.0 again, the same asapi_version. It became 1.1.0 by mistake on 11 November. A test now keeps them the same. - Added: each route in the description has
x-scope, the scope a key needs for it (nullfor none).
Plug-in API 1.4.0, 12 November 2026
- Added: settings may be
required, and a plug-in may setsetup_required. Until it is set up, it is in theneeds-setupstate and cannot be activated. - Added:
notices,p2pandadult, shown with the install warning. - Added:
events:item.added,download.finished,app.down,app.upandplayback.started, sent as a POST to/events. Each needs the read permission that covers what it tells. - Added:
jobs, up to eight, run by Starboard's clock:daily,every_hoursorat_start, withtime_limit_minutesandquiet_hours. They show in System, then Jobs. - Added: card
refresh_minutes, from 1 to 1440. - Added: catalogue versions, each with
starboard_apiandmanifest_sha256. Starboard offers the newest version that fits, and refuses a manifest whose SHA-256 does not match. - Added: Update to a newer version and Roll back to the one before, and the
not-supportedandfailedstates with one button each. - Added: catalogues added from a link, up to 10.
Plug-in API 1.3.0, 12 November 2026
- Added: a
foldersetting is a folder inside the media folders the plug-in mounts (media:roormedia/<one folder>), chosen with Browse. Afoldersetting without such a mount is refused.
Plug-in API 1.2.0, 12 November 2026
- Added: styles may also set card, button, border, tab, header, side menu and chip styles.
- Changed: a plug-in may list up to 32 styles, up from 16.
Plug-in API 1.1.0, 11 November 2026
- Added: styles may set more colours (status, side menu, panel, chart and logo), a heading font and weight, the focus width, and two more shadows.
Starboard API, description 1.1.0, 11 November 2026
- Changed: the description's
info.versionbecame 1.1.0, released with plug-in API 1.1. No address or answer changed, andGET /api/v1/still answersapi_version1.0.0.
Starboard API 1.0.0, 10 November 2026
- Added: version 1 of the API, read only, at
/api/v1:/,/me,/openapi.json,/apps,/apps/{id},/status,/health,/downloads,/recent,/playingand/system. - Added: keys of its own,
sb_read_..., made and revoked in Settings, Security with the password, shown once, kept only as SHA-256, with optional scopes and an end date. - Security: keys are read only from the
Authorization: Bearerheader. Wrong keys count towards the sign-in lockout for each address, and every key made, revoked or refused is written to the audit log. - Added: problem details for errors,
limitandcursorfor lists,ETagand304, 120 requests a minute for each key withRateLimitheaders, andX-Request-Idon every answer. - Fixed: each error's
typelinks to its entry in the list of API errors.
Plug-in API 1.0.0, 10 November 2026
- Added: the manifest, version 1, with its JSON Schema and a check that says what is wrong.
- Added: permissions in plain words with their risk, and an API key for each plug-in with exactly the scopes of its read permissions.
- Added: the Compose file Starboard writes for each plug-in, with defaults the plug-in cannot change: read only, no extra rights, not root, memory and processor limits, its own network and only its own folders.
- Added: settings, cards (
stat,listandstatus), actions,health,needsand styles, and the plug-in tester. - Added, 11 November 2026:
customsettings, a list the plug-in describes and Starboard draws.
Find out more
This page on GitHub, where the help is written.