API der bisherigen Apps

Fortgeschritten

Richte eine App, die nur Sonarr oder Radarr kennt, auf HolyArrs. Gib ihr eine Adresse, die auf /sonarr oder /radarr endet, und einen Schlüssel. Dann behandelt sie HolyArrs wie diese App.

Das ist eine kleine API, die nur für diese Apps gemacht ist. Für deine eigenen Skripte nutzt du die HolyArrs-API.

Einschalten

Standardmäßig ist sie aus. Solange sie aus ist, antwortet jede Adresse unter /sonarr/ und /radarr/ mit 404.

Öffne Settings > API (Einstellungen > API).
Schalte auf der Karte Requests from Seerr and Overseerr (Anfragen von Seerr und Overseerr) den Schalter Answer Seerr and Overseerr (Seerr und Overseerr antworten) ein.
Klicke neben Shows (Serien) auf Make key (Schlüssel erstellen). Das ist der Sonarr-Schlüssel. Kopiere ihn jetzt; er wird nur einmal angezeigt.
Klicke neben Movies (Filme) auf Make key. Das ist der Radarr-Schlüssel. Kopiere ihn auch.
Notiere dir die Adresse für jede Seite von der Karte, etwa /sonarr. Mit einer URL base zeigt sie /holyarrs/sonarr. Nutze, was die Karte zeigt.

Beim Erstellen eines Schlüssels fragt HolyArrs noch einmal nach deinem Passwort, wenn du dich nicht vor Kurzem damit angemeldet hast. Richte danach jede App ein: siehe API der bisherigen Apps: Clients.

Einstellungen der Karte

Einstellung	Was sie tut	Standard
Answer Seerr and Overseerr	Schaltet `/sonarr` und `/radarr` gemeinsam ein oder aus.	Aus
Make key / New key (neuer Schlüssel)	Erstellt den Schlüssel für diese Seite. Ein neuer Schlüssel macht den alten sofort ungültig.
Remove key (Schlüssel entfernen)	Löscht den Schlüssel dieser Seite. Apps, die ihn nutzen, werden abgelehnt.
Let these apps delete files	Aus: Entfernst du einen Titel in einer App, bleiben die Dateien. Ein: Die Dateien kommen zuerst in den Aufbewahrungsordner, wie bei jedem Löschen in HolyArrs.	Aus

Für jeden Schlüssel zeigt die Karte seine letzten 4 Zeichen, wer ihn erstellt hat und wann er zuletzt genutzt wurde.

Für Fortgeschrittene

Den Schlüssel senden

HolyArrs liest den Schlüssel von der ersten Stelle, an der es einen findet, in dieser Reihenfolge. Ein falscher Schlüssel an einer früheren Stelle schlägt fehl, auch wenn ein späterer richtig ist.

Reihenfolge	Stelle	Beispiel
1	Query-Wert `apikey`, Groß- und Kleinschreibung egal	`/sonarr/api/v3/series?apikey=KEY`
2	Header `X-Api-Key`	`X-Api-Key: KEY`
3	Header `Authorization`, mit oder ohne `Bearer`	`Authorization: Bearer KEY`

curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Die Query-Form wird nur unter diesen Adressen akzeptiert, und HolyArrs verbirgt sie im eigenen Log. Ein Reverse Proxy davor kann trotzdem die ganze Adresse ins Log schreiben.

Regeln für Schlüssel

Jede Seite hat ihren eigenen Schlüssel, der nur auf dieser Karte erstellt wird. API-Schlüssel von HolyArrs (sie beginnen mit hak_) funktionieren hier nicht, und diese Schlüssel funktionieren nirgendwo sonst.
Ein Schlüssel handelt als die Person, die ihn erstellt hat. Sie braucht die Berechtigung, die Bibliothek zu verwalten. Prowlarr braucht außerdem die Berechtigung, Einstellungen zu ändern.
Wird diese Person ausgeschaltet oder verliert sie die Berechtigung, werden Apps abgelehnt, bis jemand einen neuen Schlüssel erstellt. Die Karte warnt dich.

Mit der HolyArrs-API verwalten

Angemeldet mit deinem Passwort. Aufrufe für Schlüssel brauchen eine Anmeldung mit Passwort, die noch nicht lange her ist.

Was	Aufruf
Schalter, Adressen und Schlüssel lesen	`GET /api/v1/settings/old-app-api`
Einschalten	`PUT /api/v1/settings/old-app-api` mit `{"enabled": true}`
Apps Dateien löschen lassen	`PUT /api/v1/settings/old-app-api` mit `{"delete_files": true}`
Den Sonarr-Schlüssel erstellen	`POST /api/v1/settings/old-app-api/keys/sonarr`
Den Radarr-Schlüssel erstellen	`POST /api/v1/settings/old-app-api/keys/radarr`
Einen Schlüssel entfernen	`DELETE /api/v1/settings/old-app-api/keys/sonarr` (oder `radarr`)

API der bisherigen Apps

Einschalten

Einstellungen der Karte

Für Fortgeschrittene

Verwandte Seiten