Skip to content

Admin API

The endpoints reserved to administrators: what Admin in the web app calls. One file per service, grouped by area.

System

Spec Description
admin_system.swagger.json Dashboard, system info, setup wizard
server_config.swagger.json Server configuration key/value store
remote_access.swagger.json Remote access and network settings
backup.swagger.json Database backup and restore
backup_schedule.swagger.json Scheduled backups: cron, retention, run now
activity.swagger.json Play history, login history, server metrics
admin_session.swagger.json Audit log
admin_task.swagger.json Scheduled background tasks
presence.swagger.json Who is connected right now (the apps' heartbeat and the admin list)

Media and transcoding

Spec Description
admin_media.swagger.json Media health (scans, repairs, history and undo), delete media items, refresh metadata, generate trickplay
metadata.swagger.json Metadata providers, search, overrides
transcoding.swagger.json Transcode profiles, hardware detection, active jobs
transcode_cache.swagger.json Transcode cache management
mkv.swagger.json MKV container tools (tracks, chapters, mux/demux)
admin_intro.swagger.json Intro timing cache: invalidate one episode, backfill

Users and policies

Spec Description
library_access.swagger.json Per-user library access control
parental.swagger.json Parental controls and PIN
playback_settings.swagger.json Global playback settings

Authentication

Every endpoint needs an administrator: the session token of an administrator account, or an API key, which always belongs to one and must carry the scope the method asks for (a key without scopes reaches no admin method). A plugin token is refused here whatever its scopes (Server API).