舊 App API

進階

讓只認得 Sonarr 或 Radarr 的 App 連到 HolyArrs。給它一個以 /sonarr 或 /radarr 結尾的位址和一把金鑰，它就會把 HolyArrs 當成那個 App。

這是一個專為這些 App 準備的小型 API。你自己的腳本請使用 HolyArrs API。

開啟

預設是關閉的。關閉時，/sonarr/ 和 /radarr/ 底下的每個位址都會回應 404。

開啟 Settings > API（設定 > API）。
在 Requests from Seerr and Overseerr（來自 Seerr 和 Overseerr 的請求）卡片上，開啟 Answer Seerr and Overseerr（回應 Seerr 和 Overseerr）。
按下 Shows（影集）旁邊的 Make key（建立金鑰）。這是 Sonarr 端的金鑰。請立刻複製；它只會顯示一次。
按下 Movies（電影）旁邊的 Make key。這是 Radarr 端的金鑰。也請複製下來。
記下卡片上兩端各自的位址，例如 /sonarr。如果使用了 URL base，會顯示 /holyarrs/sonarr。請使用卡片上顯示的位址。

如果你最近沒有用密碼登入，建立金鑰時會再要求輸入一次密碼。接著設定每個 App：請見舊 App API 用戶端。

設定項目	作用	預設
Answer Seerr and Overseerr	一次開啟或關閉 `/sonarr` 和 `/radarr`。	關閉
Make key / New key（新金鑰）	建立該端的金鑰。新金鑰會讓舊金鑰立即失效。
Remove key（移除金鑰）	刪除該端的金鑰。使用它的 App 會被拒絕。
Let these apps delete files	關閉時，在 App 中移除作品會保留檔案。開啟時，檔案會先放進保留資料夾，和 HolyArrs 的每一次刪除一樣。	關閉

卡片會顯示每把金鑰的最後 4 個字元、建立者，以及最後一次使用的時間。

傳送金鑰

HolyArrs 會依下列順序，從找到的第一個位置讀取金鑰。前面的位置若是錯誤的金鑰就會失敗，即使後面的是對的。

順序	位置	範例
1	`apikey` 查詢值，大小寫皆可	`/sonarr/api/v3/series?apikey=KEY`
2	`X-Api-Key` 標頭	`X-Api-Key: KEY`
3	`Authorization` 標頭，有沒有 `Bearer` 都可以	`Authorization: Bearer KEY`

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

只有這些位址接受查詢形式，HolyArrs 會在自己的 log 中隱藏它。前面的 reverse proxy 仍可能記錄完整位址。

金鑰規則

用 HolyArrs API 管理

以你的密碼登入。金鑰相關的呼叫需要最近用密碼登入過。

項目	呼叫
讀取開關、位址和金鑰	`GET /api/v1/settings/old-app-api`
開啟	`PUT /api/v1/settings/old-app-api` 並帶入 `{"enabled": true}`
允許 App 刪除檔案	`PUT /api/v1/settings/old-app-api` 並帶入 `{"delete_files": true}`
建立 Sonarr 端的金鑰	`POST /api/v1/settings/old-app-api/keys/sonarr`
建立 Radarr 端的金鑰	`POST /api/v1/settings/old-app-api/keys/radarr`
移除金鑰	`DELETE /api/v1/settings/old-app-api/keys/sonarr`（或 `radarr`）