Zum Inhalt springen
HolyArrsDocsHolyArrs.com

API-Routen

Fortgeschritten

Rufe aus deinen eigenen Skripten dieselbe JSON-API auf, die auch die Web-App nutzt. Sie liegt unter /api/v1.

Der erste Aufruf

Link zu Der erste Aufruf
  1. Öffne Settings > API > API keys (Einstellungen > API > API-Schlüssel) und erstelle einen Schlüssel, der nur die Scopes hat, die er braucht. Kopiere ihn gleich; er wird nur einmal angezeigt.
  2. Sende ihn bei jedem Aufruf im Header X-Api-Key. Schreibe ihn nie in die Adresse.
  3. Rufe die Basisadresse auf. Mit einer URL base von /holyarrs lautet sie http://your-server:6262/holyarrs/api/v1.
Terminal window
export HOLYARRS_KEY=...your key...
curl -H "X-Api-Key: $HOLYARRS_KEY" "http://your-server:6262/api/v1/health"

Du solltest JSON zurückbekommen. Fehler haben die Form {"error": "plain words"} mit einem HTTP-Status. Geheime Werte kommen maskiert zurück.

Settings > API zeigt die Basisadresse, die Scopes, Beispielaufrufe und jede Route mit ihrem Scope. Die OpenAPI-Datei liegt unter /api/v1/openapi.json, wenn du angemeldet bist.

Scopes

Link zu Scopes
Scope Erlaubt
health_read Nur den Zustands-Feed, für Monitoring-Tools.
read Die Leserouten, einschließlich Zustands-Feed.
write Änderungen, außer Admin-Routen und Steuerung.
admin Personen, Einladungen, Anfragelimits, API-Schlüssel, Passwörter und Zwei-Faktor-Anmeldung, Anmeldeeinstellungen, Wiederherstellung.
control Bereichsschalter, Stufen, verknüpfte Apps, Neustart und Herunterfahren.
all read, write und admin. Nicht control.

Seerr, Bazarr und ähnliche Apps nutzen stattdessen die API der bisherigen Apps, mit eigenen Schlüsseln.

Wenn es nicht funktioniert

Link zu Wenn es nicht funktioniert
Symptom Ursache Lösung
401 bei jedem Aufruf Schlüssel falsch oder gelöscht Erstelle einen neuen Schlüssel.
403 Der Scope des Schlüssels deckt die Route nicht ab Prüfe den Scope der Route unter Settings > API.
404 bei jedem Aufruf URL base fehlt Setze sie vor /api/v1.

Für Fortgeschrittene

Link zu Für Fortgeschrittene
Aufrufe an den Metadaten-Server

HolyArrs holt Namen, Bilder und IDs vom HolyArrs-Metadaten-Server. Mit HOLYARRS_METADATA_URL lässt du eine Installation einen anderen Server nutzen; der Servercode liegt nicht in diesem Repo.

Registrierung. Bei ihrer ersten Abfrage ruft eine Installation POST /v1/installations ohne Body auf. Die Antwort ist 201 mit {"schema_version":1,"token":"hai_..."}. Die App speichert das Token verschlüsselt und sendet bei jeder Abfrage Authorization: Bearer <token>. Sie registriert sich einmal; nach einem 401 registriert sie sich nicht erneut, eine widerrufene Installation bleibt also widerrufen. Über dem Stundenlimit pro Adressgruppe ist die Antwort 429 registration_limit mit Retry-After.

Abfrage (immer GET) Route
Suche /v1/search?provider=tmdb&kind=movie&q=Example&page=1
Film /v1/movies/tmdb/{id}
Serie /v1/shows/{tmdb or tvmaze}/{id}
Staffel /v1/shows/tmdb/{id}/seasons/{n} (Staffel 0 sind die Specials)
Musik /v1/music/musicbrainz/{artist, release-group, release or recording}/{id}

Unbekannte oder doppelte Parameter werden abgelehnt. IDs eines Anbieters werden nie für einen anderen verwendet.

Eine gültige Antwort enthält schema_version, source, source_id, fetched_at, expires_at, completeness, stale und data. Behandle HTML in Zusammenfassungen als reinen Text.

Status Bedeutung
400 Fehlerhafte Abfrage, nicht wiederholen
401 Ungültiges oder widerrufenes Token, nicht wiederholen
404 Kein solcher Eintrag
429 Zu viele Aufrufe, Retry-After abwarten
503 Ausgelastet, warten und einmal wiederholen
Eine Route hinzufügen

Routen liegen in der routes.go jedes Moduls und werden mit Methode, Pfad und Berechtigung registriert. So gibt es keine Route ohne Berechtigungsprüfung. openapi.json entsteht aus den Routen, und ein Test schlägt fehl, wenn beide auseinanderlaufen. Nach der Veröffentlichung bleiben Pfade und Feldnamen, wie sie sind: Füge Felder hinzu, benenne sie nicht um.

Alle Routen

Link zu Alle Routen

520 Routen. Erzeuge sie neu mit go run ./app/backend/tools/apidoc.

Die Spalte Auth nennt die Berechtigung, die ein Aufrufer braucht, so wie sie im Snapshot festgehalten ist. Die Spalte Zweck ist nur dort gefüllt, wo die Routenregistrierung einen Kommentar hat.

account

Link zu account
Methode Pfad Auth Zweck
PUT /api/v1/account/avatar self
DELETE /api/v1/account/avatar self

albums

Link zu albums
Methode Pfad Auth Zweck
GET /api/v1/albums/{id} signed_in
PUT /api/v1/albums/{id} manage_library
GET /api/v1/albums/{id}/cover signed_in
GET /api/v1/albums/{id}/tracks signed_in

alerts

Link zu alerts
Methode Pfad Auth Zweck
GET /api/v1/alerts settings
POST /api/v1/alerts settings
PUT /api/v1/alerts/{id} settings
DELETE /api/v1/alerts/{id} settings
POST /api/v1/alerts/{id}/test settings

app

Link zu app
Methode Pfad Auth Zweck
GET /api/v1/app/about settings
POST /api/v1/app/restart users
POST /api/v1/app/safe-mode users
POST /api/v1/app/shutdown users
GET /api/v1/app/storage settings
GET /api/v1/app/update manage_library
POST /api/v1/app/update/check settings

artists

Link zu artists
Methode Pfad Auth Zweck
POST /api/v1/artists manage_library
GET /api/v1/artists/lookup signed_in

artwork

Link zu artwork
Methode Pfad Auth Zweck
GET /api/v1/artwork/img/{kind}/{id}/{file} signed_in
GET /api/v1/artwork/tmdb/{size}/{file} signed_in
GET /api/v1/artwork/{name} signed_in

ask-limits

Link zu ask-limits
Methode Pfad Auth Zweck
GET /api/v1/ask-limits users
PUT /api/v1/ask-limits/{id} users

asked-by

Link zu asked-by
Methode Pfad Auth Zweck
GET /api/v1/asked-by signed_in

asks

Link zu asks
Methode Pfad Auth Zweck
GET /api/v1/asks signed_in
POST /api/v1/asks ask
GET /api/v1/asks/limit ask
GET /api/v1/asks/{id} signed_in
DELETE /api/v1/asks/{id} ask
POST /api/v1/asks/{id}/approve approve
GET /api/v1/asks/{id}/parts signed_in
POST /api/v1/asks/{id}/turn-down approve

auth

Link zu auth
Methode Pfad Auth Zweck
GET /api/v1/auth/ai-connect signed_in
POST /api/v1/auth/ai-connect settings
POST /api/v1/auth/forward/link self
POST /api/v1/auth/forward/login public
POST /api/v1/auth/import/{kind} owner
POST /api/v1/auth/import/{kind}/preview owner
GET /api/v1/auth/invites/{token} unlisted
POST /api/v1/auth/invites/{token} unlisted
POST /api/v1/auth/invites/{token}/media-server/{kind} unlisted
POST /api/v1/auth/invites/{token}/plex/finish unlisted
POST /api/v1/auth/invites/{token}/plex/start unlisted
GET /api/v1/auth/keys settings
POST /api/v1/auth/keys settings
DELETE /api/v1/auth/keys/{id} settings
POST /api/v1/auth/login unlisted
POST /api/v1/auth/login/two-factor unlisted
POST /api/v1/auth/logout self
GET /api/v1/auth/me self
POST /api/v1/auth/media-server/{kind} unlisted
POST /api/v1/auth/media-server/{kind}/test owner
GET /api/v1/auth/oidc/callback public
POST /api/v1/auth/oidc/finish public
POST /api/v1/auth/oidc/link self
POST /api/v1/auth/oidc/link-finish self
POST /api/v1/auth/oidc/start public
POST /api/v1/auth/password self
POST /api/v1/auth/plex/finish unlisted
DELETE /api/v1/auth/plex/link owner
POST /api/v1/auth/plex/link/finish owner
POST /api/v1/auth/plex/link/start owner
GET /api/v1/auth/plex/my-link self
DELETE /api/v1/auth/plex/my-link self
POST /api/v1/auth/plex/my-link/finish self
POST /api/v1/auth/plex/my-link/start self
POST /api/v1/auth/plex/start unlisted
POST /api/v1/auth/reauth self
GET /api/v1/auth/sessions self
DELETE /api/v1/auth/sessions self
DELETE /api/v1/auth/sessions/{sid} self
GET /api/v1/auth/settings settings
PUT /api/v1/auth/settings owner
POST /api/v1/auth/setup unlisted
GET /api/v1/auth/setup/discover unlisted
POST /api/v1/auth/setup/done owner
POST /api/v1/auth/setup/media-server/{kind} unlisted
POST /api/v1/auth/setup/plex/finish unlisted
POST /api/v1/auth/setup/plex/start unlisted
GET /api/v1/auth/sso owner
PUT /api/v1/auth/sso owner
GET /api/v1/auth/sso/links self
POST /api/v1/auth/sso/test owner
POST /api/v1/auth/sso/unlink self
GET /api/v1/auth/state unlisted
POST /api/v1/auth/two-factor/backup-codes self
POST /api/v1/auth/two-factor/disable self
POST /api/v1/auth/two-factor/enable self
POST /api/v1/auth/two-factor/setup self

backups

Link zu backups
Methode Pfad Auth Zweck
GET /api/v1/backups settings
POST /api/v1/backups settings
POST /api/v1/backups/restore owner
PUT /api/v1/backups/settings settings
GET /api/v1/backups/{name} owner
DELETE /api/v1/backups/{name} owner

bridges

Link zu bridges
Methode Pfad Auth Zweck
GET /api/v1/bridges manage_library
POST /api/v1/bridges settings
POST /api/v1/bridges/find settings
POST /api/v1/bridges/test settings
DELETE /api/v1/bridges/{id} settings
POST /api/v1/bridges/{id}/check settings

calendar

Link zu calendar
Methode Pfad Auth Zweck
GET /api/v1/calendar signed_in

collections

Link zu collections
Methode Pfad Auth Zweck
GET /api/v1/collections signed_in
GET /api/v1/collections/{id} signed_in
POST /api/v1/collections/{id}/remove manage_library
POST /api/v1/collections/{id}/remove/preview manage_library

data-packs

Link zu data-packs
Methode Pfad Auth Zweck
GET /api/v1/data-packs owner
POST /api/v1/data-packs owner
POST /api/v1/data-packs/validate owner
GET /api/v1/data-packs/{id} owner
POST /api/v1/data-packs/{id}/apply owner
GET /api/v1/data-packs/{id}/preview owner

discover

Link zu discover
Methode Pfad Auth Zweck
GET /api/v1/discover signed_in

downloaders

Link zu downloaders
Methode Pfad Auth Zweck
GET /api/v1/downloaders manage_library
POST /api/v1/downloaders settings
PUT /api/v1/downloaders/{id} settings
DELETE /api/v1/downloaders/{id} settings
GET /api/v1/downloaders/{id}/attempts settings
POST /api/v1/downloaders/{id}/attempts/{attemptID}/abandon settings
POST /api/v1/downloaders/{id}/bulk manage_library
POST /api/v1/downloaders/{id}/items/{hash}/bottom manage_library
GET /api/v1/downloaders/{id}/items/{hash}/detail manage_library
POST /api/v1/downloaders/{id}/items/{hash}/down manage_library
GET /api/v1/downloaders/{id}/items/{hash}/files manage_library
PUT /api/v1/downloaders/{id}/items/{hash}/files manage_library
POST /api/v1/downloaders/{id}/items/{hash}/pause manage_library
POST /api/v1/downloaders/{id}/items/{hash}/priority manage_library
POST /api/v1/downloaders/{id}/items/{hash}/reannounce manage_library
POST /api/v1/downloaders/{id}/items/{hash}/recheck manage_library
POST /api/v1/downloaders/{id}/items/{hash}/remove manage_library
POST /api/v1/downloaders/{id}/items/{hash}/resume manage_library
POST /api/v1/downloaders/{id}/items/{hash}/retry manage_library
GET /api/v1/downloaders/{id}/items/{hash}/swarm manage_library
POST /api/v1/downloaders/{id}/items/{hash}/top manage_library
POST /api/v1/downloaders/{id}/items/{hash}/trackers manage_library
PUT /api/v1/downloaders/{id}/items/{hash}/trackers manage_library
POST /api/v1/downloaders/{id}/items/{hash}/trackers/remove manage_library
POST /api/v1/downloaders/{id}/items/{hash}/up manage_library
GET /api/v1/downloaders/{id}/items/{hash}/usenet manage_library
POST /api/v1/downloaders/{id}/location manage_library
POST /api/v1/downloaders/{id}/pause settings
POST /api/v1/downloaders/{id}/resume settings
POST /api/v1/downloaders/{id}/share-limits manage_library
POST /api/v1/downloaders/{id}/slow-mode manage_library
PUT /api/v1/downloaders/{id}/speed-limit manage_library
POST /api/v1/downloaders/{id}/speed-limits manage_library
POST /api/v1/downloaders/{id}/test settings
POST /api/v1/downloaders/{id}/torrents manage_library

downloads

Link zu downloads
Methode Pfad Auth Zweck
GET /api/v1/downloads manage_library
GET /api/v1/downloads/clients manage_library
GET /api/v1/downloads/matches manage_library
POST /api/v1/downloads/matches/run manage_library
POST /api/v1/downloads/matches/{id}/pick manage_library
POST /api/v1/downloads/pause-all manage_library
POST /api/v1/downloads/resume-all manage_library
GET /api/v1/downloads/view signed_in
GET /api/v1/downloads/{id}/detail manage_library
PUT /api/v1/downloads/{id}/edition manage_library
GET /api/v1/downloads/{id}/files manage_library
PUT /api/v1/downloads/{id}/files manage_library
POST /api/v1/downloads/{id}/mark-failed manage_library
POST /api/v1/downloads/{id}/pause manage_library
POST /api/v1/downloads/{id}/reannounce manage_library
POST /api/v1/downloads/{id}/recheck manage_library
POST /api/v1/downloads/{id}/remove manage_library
POST /api/v1/downloads/{id}/resume manage_library
GET /api/v1/downloads/{id}/swarm manage_library
POST /api/v1/downloads/{id}/top manage_library
GET /api/v1/downloads/{id}/usenet manage_library

episodes

Link zu episodes
Methode Pfad Auth Zweck
PUT /api/v1/episodes/{id} manage_library

events

Link zu events
Methode Pfad Auth Zweck
GET /api/v1/events manage_library

explore

Link zu explore
Methode Pfad Auth Zweck
GET /api/v1/explore/browse signed_in
GET /api/v1/explore/browse/category signed_in
GET /api/v1/explore/browse/section signed_in
POST /api/v1/explore/counts signed_in
GET /api/v1/explore/genre signed_in
GET /api/v1/explore/genre-row signed_in
GET /api/v1/explore/head signed_in
GET /api/v1/explore/music signed_in
GET /api/v1/explore/music/rising signed_in
GET /api/v1/explore/new signed_in
GET /api/v1/explore/new/music signed_in
GET /api/v1/explore/new/service signed_in
GET /api/v1/explore/new/services signed_in
GET /api/v1/explore/service-top signed_in
GET /api/v1/explore/strip signed_in
POST /api/v1/explore/strip/counts signed_in
DELETE /api/v1/explore/strip/counts signed_in
GET /api/v1/explore/tail signed_in
GET /api/v1/explore/title-stats owner
GET /api/v1/explore/top signed_in

extras

Link zu extras
Methode Pfad Auth Zweck
GET /api/v1/extras/{kind}/{id} signed_in

files

Link zu files
Methode Pfad Auth Zweck
POST /api/v1/files/{id}/subtitles/choices manage_library
POST /api/v1/files/{id}/subtitles/choose manage_library

health

Link zu health
Methode Pfad Auth Zweck
GET /api/v1/health manage_library
GET /api/v1/health/checks manage_library
POST /api/v1/health/checks/run manage_library
GET /api/v1/health/disks manage_library
GET /api/v1/health/states manage_library

held

Link zu held
Methode Pfad Auth Zweck
GET /api/v1/held manage_library
DELETE /api/v1/held manage_library
DELETE /api/v1/held/{id} manage_library

holding

Link zu holding
Methode Pfad Auth Zweck
GET /api/v1/holding manage_library
POST /api/v1/holding/clean manage_library
POST /api/v1/holding/restore manage_library

home

Link zu home
Methode Pfad Auth Zweck
GET /api/v1/home signed_in

imports

Link zu imports
Methode Pfad Auth Zweck
GET /api/v1/imports manage_library

jobs

Link zu jobs
Methode Pfad Auth Zweck
GET /api/v1/jobs manage_library
GET /api/v1/jobs/active manage_library
GET /api/v1/jobs/{id} manage_library

library

Link zu library
Methode Pfad Auth Zweck
GET /api/v1/library/copies manage_library
POST /api/v1/library/copies/search manage_library
POST /api/v1/library/copies/search/preview manage_library
GET /api/v1/library/search signed_in

library-folders

Link zu library-folders
Methode Pfad Auth Zweck
GET /api/v1/library-folders manage_library
POST /api/v1/library-folders settings
PUT /api/v1/library-folders/{id} settings
DELETE /api/v1/library-folders/{id} settings
POST /api/v1/library-folders/{id}/adopt manage_library
POST /api/v1/library-folders/{id}/check manage_library
POST /api/v1/library-folders/{id}/scan manage_library
Link zu links
Methode Pfad Auth Zweck
POST /api/v1/links/{kind}/{id}/restart users

live

Link zu live
Methode Pfad Auth Zweck
POST /api/v1/live/interest signed_in

logs

Link zu logs
Methode Pfad Auth Zweck
GET /api/v1/logs users
GET /api/v1/logs/download users

manual-import

Link zu manual-import
Methode Pfad Auth Zweck
POST /api/v1/manual-import settings
POST /api/v1/manual-import/scan settings

mcp

Link zu mcp
Methode Pfad Auth Zweck
GET /api/v1/mcp signed_in
POST /api/v1/mcp signed_in

media-servers

Link zu media-servers
Methode Pfad Auth Zweck
GET /api/v1/media-servers settings
POST /api/v1/media-servers settings
PUT /api/v1/media-servers/{id} settings
DELETE /api/v1/media-servers/{id} settings
POST /api/v1/media-servers/{id}/test settings

messages

Link zu messages
Methode Pfad Auth Zweck
GET /api/v1/messages signed_in
POST /api/v1/messages/read signed_in

metadata

Link zu metadata
Methode Pfad Auth Zweck
GET /api/v1/metadata/album/{mbid}/follow signed_in
PUT /api/v1/metadata/album/{mbid}/follow signed_in
DELETE /api/v1/metadata/album/{mbid}/follow signed_in
GET /api/v1/metadata/health signed_in
GET /api/v1/metadata/movie/{tmdb_id}/follow signed_in
PUT /api/v1/metadata/movie/{tmdb_id}/follow signed_in
DELETE /api/v1/metadata/movie/{tmdb_id}/follow signed_in
GET /api/v1/metadata/search signed_in
GET /api/v1/metadata/show/{tmdb_id}/follow signed_in
PUT /api/v1/metadata/show/{tmdb_id}/follow signed_in
DELETE /api/v1/metadata/show/{tmdb_id}/follow signed_in
GET /api/v1/metadata/show/{tmdb_id}/seasons/{number} signed_in
GET /api/v1/metadata/{kind}/{tmdb_id} signed_in
GET /api/v1/metadata/{kind}/{tmdb_id}/anime signed_in
GET /api/v1/metadata/{kind}/{tmdb_id}/more-from signed_in
GET /api/v1/metadata/{kind}/{tmdb_id}/reviews signed_in

migrate

Link zu migrate
Methode Pfad Auth Zweck
POST /api/v1/migrate/dry-run users
GET /api/v1/migrate/moves users
POST /api/v1/migrate/moves users
GET /api/v1/migrate/moves/{id} users
GET /api/v1/migrate/moves/{id}/report users
POST /api/v1/migrate/moves/{id}/undo users
POST /api/v1/migrate/plan users
POST /api/v1/migrate/probe users
POST /api/v1/migrate/read users
GET /api/v1/migrate/saved-keys owner
DELETE /api/v1/migrate/saved-keys owner
GET /api/v1/migrate/snapshots users
GET /api/v1/migrate/snapshots/{id} users
DELETE /api/v1/migrate/snapshots/{id} users

music

Link zu music
Methode Pfad Auth Zweck
GET /api/v1/music/albums/{mbid} signed_in
GET /api/v1/music/artists/{mbid} signed_in
GET /api/v1/music/browse-tiles signed_in
GET /api/v1/music/browse/{kind}/{slug} signed_in
GET /api/v1/music/genre-art/{slug} signed_in
GET /api/v1/music/genre/{slug} signed_in
Link zu music-trending
Methode Pfad Auth Zweck
GET /api/v1/music-trending signed_in
GET /api/v1/music-trending/art/{kind}/{mbid} signed_in

my

Link zu my
Methode Pfad Auth Zweck
GET /api/v1/my/alerts signed_in
PUT /api/v1/my/alerts signed_in
GET /api/v1/my/follows signed_in
GET /api/v1/my/plex-watchlist signed_in
PUT /api/v1/my/plex-watchlist signed_in
POST /api/v1/my/plex-watchlist/check signed_in
GET /api/v1/my/profile signed_in
PUT /api/v1/my/profile signed_in

needs-decision

Link zu needs-decision
Methode Pfad Auth Zweck
GET /api/v1/needs-decision manage_library
POST /api/v1/needs-decision/{id}/decide manage_library

never-add

Link zu never-add
Methode Pfad Auth Zweck
GET /api/v1/never-add manage_library
POST /api/v1/never-add manage_library
DELETE /api/v1/never-add/{id} manage_library

openapi.json

Link zu openapi.json
Methode Pfad Auth Zweck
GET /api/v1/openapi.json signed_in

outside-lists

Link zu outside-lists
Methode Pfad Auth Zweck
GET /api/v1/outside-lists settings
POST /api/v1/outside-lists settings
PUT /api/v1/outside-lists/{id} settings
DELETE /api/v1/outside-lists/{id} settings
POST /api/v1/outside-lists/{id}/sync settings

own-traits

Link zu own-traits
Methode Pfad Auth Zweck
GET /api/v1/own-traits manage_library
POST /api/v1/own-traits settings
PUT /api/v1/own-traits/{id} settings
DELETE /api/v1/own-traits/{id} settings

parts

Link zu parts
Methode Pfad Auth Zweck
GET /api/v1/parts signed_in
POST /api/v1/parts/{part}/off users
POST /api/v1/parts/{part}/on users
POST /api/v1/parts/{part}/restart users

people

Link zu people
Methode Pfad Auth Zweck
GET /api/v1/people/popular signed_in
GET /api/v1/people/search signed_in
GET /api/v1/people/shelves signed_in
GET /api/v1/people/shelves/{id} signed_in
GET /api/v1/people/{id} signed_in
POST /api/v1/people/{id}/movies/review signed_in

pick-rules

Link zu pick-rules
Methode Pfad Auth Zweck
GET /api/v1/pick-rules manage_library
POST /api/v1/pick-rules settings
GET /api/v1/pick-rules/{id} manage_library
PUT /api/v1/pick-rules/{id} settings
DELETE /api/v1/pick-rules/{id} settings

public

Link zu public
Methode Pfad Auth Zweck
GET /api/v1/public/signin-art public
GET /api/v1/public/signin-pic/t/p/{size}/{file} public Ein festes Muster (= signinPicPath + “{size}/{file}”): Die Routentests lesen es aus dem Quelltext.

releases

Link zu releases
Methode Pfad Auth Zweck
POST /api/v1/releases/{id}/choose manage_library
POST /api/v1/releases/{id}/turn-down manage_library

rename

Link zu rename
Methode Pfad Auth Zweck
GET /api/v1/rename manage_library
POST /api/v1/rename manage_library

reports

Link zu reports
Methode Pfad Auth Zweck
GET /api/v1/reports signed_in
POST /api/v1/reports signed_in
POST /api/v1/reports/{id}/fix manage_library
POST /api/v1/reports/{id}/reopen manage_library

schedules

Link zu schedules
Methode Pfad Auth Zweck
GET /api/v1/schedules manage_library
PUT /api/v1/schedules/{kind} settings
POST /api/v1/schedules/{kind}/run manage_library
Link zu search
Methode Pfad Auth Zweck
GET /api/v1/search signed_in
POST /api/v1/search/better manage_library
POST /api/v1/search/feed-check manage_library
POST /api/v1/search/missing manage_library
GET /api/v1/search/suggest signed_in

searches

Link zu searches
Methode Pfad Auth Zweck
GET /api/v1/searches manage_library

settings

Link zu settings
Methode Pfad Auth Zweck
GET /api/v1/settings/ai signed_in
PUT /api/v1/settings/ai owner
GET /api/v1/settings/alerts settings
PUT /api/v1/settings/alerts settings
GET /api/v1/settings/asks settings
PUT /api/v1/settings/asks settings
GET /api/v1/settings/downloaders settings
PUT /api/v1/settings/downloaders settings
GET /api/v1/settings/files manage_library
PUT /api/v1/settings/files settings
GET /api/v1/settings/health settings
PUT /api/v1/settings/health settings
GET /api/v1/settings/import-folders settings
PUT /api/v1/settings/import-folders users
POST /api/v1/settings/import-secrets owner
GET /api/v1/settings/music manage_library
PUT /api/v1/settings/music settings
GET /api/v1/settings/naming manage_library
PUT /api/v1/settings/naming settings
POST /api/v1/settings/naming/example manage_library
GET /api/v1/settings/old-app-api settings
PUT /api/v1/settings/old-app-api settings
POST /api/v1/settings/old-app-api/keys/{side} settings
DELETE /api/v1/settings/old-app-api/keys/{side} settings
GET /api/v1/settings/release-gate manage_library
PUT /api/v1/settings/release-gate settings
GET /api/v1/settings/search settings
PUT /api/v1/settings/search settings
GET /api/v1/settings/shows manage_library
PUT /api/v1/settings/shows settings
GET /api/v1/settings/status settings
GET /api/v1/settings/subtitles settings
PUT /api/v1/settings/subtitles settings
GET /api/v1/settings/title-defaults manage_library
PUT /api/v1/settings/title-defaults settings
GET /api/v1/settings/trakt-key settings
PUT /api/v1/settings/trakt-key settings
GET /api/v1/settings/trakt-token owner
PUT /api/v1/settings/trakt-token owner
GET /api/v1/settings/ui signed_in
PUT /api/v1/settings/ui settings
GET /api/v1/settings/url-base settings
PUT /api/v1/settings/url-base settings

shows

Link zu shows
Methode Pfad Auth Zweck
POST /api/v1/shows manage_library
GET /api/v1/shows/lookup signed_in

sources

Link zu sources
Methode Pfad Auth Zweck
GET /api/v1/sources manage_library
POST /api/v1/sources settings
POST /api/v1/sources/check settings
PUT /api/v1/sources/{id} settings
DELETE /api/v1/sources/{id} settings
POST /api/v1/sources/{id}/pause settings
POST /api/v1/sources/{id}/resume settings
GET /api/v1/sources/{id}/stats manage_library
POST /api/v1/sources/{id}/test settings
POST /api/v1/sources/{id}/try settings

stages

Link zu stages
Methode Pfad Auth Zweck
POST /api/v1/stages/{name}/pause users
POST /api/v1/stages/{name}/restart users
POST /api/v1/stages/{name}/resume users

subtitle-sites

Link zu subtitle-sites
Methode Pfad Auth Zweck
GET /api/v1/subtitle-sites manage_library
POST /api/v1/subtitle-sites settings
GET /api/v1/subtitle-sites/kinds manage_library
PUT /api/v1/subtitle-sites/{id} settings
DELETE /api/v1/subtitle-sites/{id} settings
POST /api/v1/subtitle-sites/{id}/test settings

subtitles

Link zu subtitles
Methode Pfad Auth Zweck
GET /api/v1/subtitles/languages manage_library
GET /api/v1/subtitles/missing manage_library
POST /api/v1/subtitles/missing/search manage_library
POST /api/v1/subtitles/search manage_library
POST /api/v1/subtitles/{id}/sync manage_library
POST /api/v1/subtitles/{id}/turn-down manage_library

support

Link zu support
Methode Pfad Auth Zweck
GET /api/v1/support/bundle users

system

Link zu system
Methode Pfad Auth Zweck
POST /api/v1/system/key-kit owner

tags

Link zu tags
Methode Pfad Auth Zweck
GET /api/v1/tags manage_library

titles

Link zu titles
Methode Pfad Auth Zweck
GET /api/v1/titles signed_in
POST /api/v1/titles manage_library
GET /api/v1/titles/lookup signed_in
GET /api/v1/titles/owned signed_in
POST /api/v1/titles/refresh manage_library
GET /api/v1/titles/{id} signed_in
PUT /api/v1/titles/{id} manage_library
GET /api/v1/titles/{id}/albums signed_in
PUT /api/v1/titles/{id}/artist manage_library
GET /api/v1/titles/{id}/copies manage_library
POST /api/v1/titles/{id}/delete manage_library
GET /api/v1/titles/{id}/episodes signed_in
PUT /api/v1/titles/{id}/files/{fid}/choices manage_library
POST /api/v1/titles/{id}/files/{fid}/keep-and-add manage_library
GET /api/v1/titles/{id}/follow signed_in
PUT /api/v1/titles/{id}/follow signed_in
DELETE /api/v1/titles/{id}/follow signed_in
POST /api/v1/titles/{id}/move manage_library
GET /api/v1/titles/{id}/people signed_in
POST /api/v1/titles/{id}/refresh manage_library
GET /api/v1/titles/{id}/releases manage_library
GET /api/v1/titles/{id}/rename manage_library
POST /api/v1/titles/{id}/rename manage_library
POST /api/v1/titles/{id}/search manage_library
GET /api/v1/titles/{id}/search-outcome signed_in
GET /api/v1/titles/{id}/seasons signed_in
PUT /api/v1/titles/{id}/seasons/{number} manage_library
PUT /api/v1/titles/{id}/subtitle-wish manage_library
GET /api/v1/titles/{id}/subtitles manage_library
POST /api/v1/titles/{id}/versions manage_library
PUT /api/v1/titles/{id}/versions/{vid} manage_library
DELETE /api/v1/titles/{id}/versions/{vid} manage_library
POST /api/v1/titles/{id}/versions/{vid}/adopt manage_library

trailer

Link zu trailer
Methode Pfad Auth Zweck
GET /api/v1/trailer/batch signed_in
GET /api/v1/trailer/stream/{id}/manifest.m3u8 signed_in
GET /api/v1/trailer/stream/{id}/seg/{n} signed_in
GET /api/v1/trailer/{kind}/{tmdb_id} signed_in

turned-down

Link zu turned-down
Methode Pfad Auth Zweck
GET /api/v1/turned-down manage_library
DELETE /api/v1/turned-down manage_library
DELETE /api/v1/turned-down/{id} manage_library

users

Link zu users
Methode Pfad Auth Zweck
GET /api/v1/users users
GET /api/v1/users/invites users
POST /api/v1/users/invites users
DELETE /api/v1/users/invites/{id} users
PUT /api/v1/users/{id} users
GET /api/v1/users/{id}/avatar signed_in
POST /api/v1/users/{id}/password users
GET /api/v1/users/{id}/sessions users
POST /api/v1/users/{id}/sessions/end-all users
DELETE /api/v1/users/{id}/sessions/{sid} users
POST /api/v1/users/{id}/sso/unlink owner
POST /api/v1/users/{id}/two-factor/reset users

watch-services

Link zu watch-services
Methode Pfad Auth Zweck
GET /api/v1/watch-services signed_in

wiki

Link zu wiki
Methode Pfad Auth Zweck
GET /api/v1/wiki/{kind}/{id} signed_in

Sonstige (außerhalb von /api/v1)

Link zu Sonstige (außerhalb von /api/v1)
Methode Pfad Auth Zweck
GET / self
POST / unlisted
GET /.well-known/oauth-authorization-server public
GET /.well-known/oauth-protected-resource public
GET /.well-known/oauth-protected-resource/{path...} public
GET /calendar unlisted
POST /command unlisted
GET /command/{id} unlisted
GET /episode unlisted
PUT /episode/monitor unlisted
GET /healthz unlisted
GET /indexer unlisted
POST /indexer unlisted
GET /indexer/schema unlisted
POST /indexer/test unlisted
GET /indexer/{id} unlisted
PUT /indexer/{id} unlisted
DELETE /indexer/{id} unlisted
GET /languageprofile unlisted
GET /live signed_in
GET /login self
GET /mcp signed_in
POST /mcp signed_in
GET /mediacover/{id}/{file} unlisted
GET /movie unlisted
POST /movie unlisted
PUT /movie unlisted
GET /movie/lookup unlisted
GET /movie/{id} unlisted
PUT /movie/{id} unlisted
DELETE /movie/{id} unlisted
GET /oauth/authorize public
POST /oauth/register public
POST /oauth/token public
GET /qualityprofile unlisted
GET /queue unlisted
GET /queue/details unlisted
GET /radarr/ manage_library
POST /radarr/ manage_library
PUT /radarr/ manage_library
DELETE /radarr/ manage_library
GET /readyz unlisted die Startseite beantwortet sie mit 503).
GET /rootfolder unlisted
GET /series unlisted
POST /series unlisted
PUT /series unlisted
GET /series/lookup unlisted
GET /series/{id} unlisted
PUT /series/{id} unlisted
DELETE /series/{id} unlisted
GET /sonarr/ manage_library
POST /sonarr/ manage_library
PUT /sonarr/ manage_library
DELETE /sonarr/ manage_library
GET /system/status unlisted
GET /tag unlisted
POST /tag unlisted
PUT /tag unlisted
PUT /tag/{id} unlisted
GET /wanted/missing unlisted

HolyArrs ist kostenlos. Wenn es dir Zeit gespart hat, gib ihm einen Stern auf GitHub, unterstütze es als Sponsor oder spendier mir einen Kaffee.