API för tidigare appar

Peka en app som bara känner till Sonarr eller Radarr mot HolyArrs. Ge den en adress som slutar på /sonarr eller /radarr och en nyckel, så behandlar den HolyArrs som den appen.

Det här är ett litet API som bara är gjort för de apparna. För dina egna skript, använd HolyArrs API.

Slå på det

Det är av som standard. Medan det är av svarar varje adress under /sonarr/ och /radarr/ med 404.

1. Öppna Settings > API (inställningar > API).
2. På kortet Requests from Seerr and Overseerr (förfrågningar från Seerr och Overseerr) slår du på Answer Seerr and Overseerr (svara Seerr och Overseerr).
3. Klicka på Make key (skapa nyckel) bredvid Shows (serier). Det här är Sonarr-nyckeln. Kopiera den nu; den visas bara en gång.
4. Klicka på Make key bredvid Movies (filmer). Det här är Radarr-nyckeln. Kopiera den också.
5. Notera adressen för varje sida på kortet, till exempel /sonarr. Under en URL base visas /holyarrs/sonarr. Använd det kortet visar.

När du skapar en nyckel frågar HolyArrs efter ditt lösenord igen om du inte har loggat in med det nyligen. Konfigurera sedan varje app: se Klienter för API:et för tidigare appar.

Caution

Seerr lagrar nycklar som vanlig text i sin inställningsfil. Därför är Let these apps delete files (låt de här apparna radera filer) av som standard.

Inställningar på kortet

Inställning	Vad den gör	Standard
Answer Seerr and Overseerr	Slår på eller av /sonarr och /radarr tillsammans.	Av
Make key / New key (ny nyckel)	Skapar nyckeln för den sidan. En ny nyckel stoppar den gamla direkt.
Remove key (ta bort nyckel)	Raderar den sidans nyckel. Appar som använder den nekas.
Let these apps delete files	När den är av lämnar borttagning av en titel i en app kvar filerna. När den är på hamnar filerna först i kvarhållningsmappen, som vid varje radering i HolyArrs.	Av

För varje nyckel visar kortet de sista 4 tecknen, vem som skapade den och när den användes senast.

För experter

Skicka nyckeln

HolyArrs läser nyckeln från den första platsen där den hittar en, i den här ordningen. En felaktig nyckel på en tidigare plats misslyckas, även om en senare är rätt.

Ordning	Plats	Exempel
1	apikey som query-värde, med valfria versaler	/sonarr/api/v3/series?apikey=KEY
2	X-Api-Key-header	X-Api-Key: KEY
3	Authorization-header, med eller utan Bearer	Authorization: Bearer KEY

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

Query-formen godtas bara på de här adresserna, och HolyArrs döljer den i sin egen logg. En reverse proxy framför kan ändå logga hela adressen.

Regler för nycklar

• Varje sida har sin egen nyckel, som bara skapas på det här kortet. HolyArrs API-nycklar (som börjar med hak_) fungerar inte här, och de här nycklarna fungerar ingen annanstans.
• En nyckel agerar som den person som skapade den, som behöver behörighet att hantera biblioteket. Prowlarr behöver dessutom behörighet att ändra inställningar.
• Om den personen stängs av eller förlorar behörigheten nekas apparna tills någon skapar en ny nyckel. Kortet varnar dig.

Hantera det med HolyArrs API

Inloggad med ditt lösenord. Nyckelanrop kräver en nylig inloggning med lösenord.

Vad	Anrop
Läs reglage, adresser och nycklar	GET /api/v1/settings/old-app-api
Slå på det	PUT /api/v1/settings/old-app-api med {"enabled": true}
Låt appar radera filer	PUT /api/v1/settings/old-app-api med {"delete_files": true}
Skapa Sonarr-nyckeln	POST /api/v1/settings/old-app-api/keys/sonarr
Skapa Radarr-nyckeln	POST /api/v1/settings/old-app-api/keys/radarr
Ta bort en nyckel	DELETE /api/v1/settings/old-app-api/keys/sonarr (eller radarr)

Relaterat

• Klienter för API:et för tidigare appar
• Begränsningar i API:et för tidigare appar
• Reverse proxy och URL base