旧アプリ API

上級者

Sonarr か Radarr しか知らないアプリを、HolyArrs に向けられます。/sonarr または /radarr で終わるアドレスとキーを渡すと、そのアプリは HolyArrs を Sonarr や Radarr として扱います。

これは、そうしたアプリのためだけに作られた小さな API です。自分のスクリプトには HolyArrs API を使ってください。

オンにする

既定ではオフです。オフの間は、/sonarr/ と /radarr/ の下のすべてのアドレスが 404 を返します。

Settings > API を開きます。
Requests from Seerr and Overseerr(Seerr と Overseerr からのリクエスト)カードで、Answer Seerr and Overseerr(Seerr と Overseerr に応答する)をオンにします。
Shows(番組)の横にある Make key(キーを作る)をクリックします。これが Sonarr 側のキーです。表示されるのは 1 回だけなので、その場でコピーします。
Movies(映画)の横にある Make key をクリックします。これが Radarr 側のキーです。こちらもコピーします。
カードに表示される、それぞれの側のアドレスを控えます。/sonarr などです。URL ベースがある場合は /holyarrs/sonarr と表示されます。カードに表示されているとおりに使います。

しばらくパスワードでサインインしていない場合、キーを作るときにパスワードをもう一度求められます。そのあと、アプリを 1 つずつ設定します。旧アプリ API のクライアントを参照してください。

設定	内容	既定値
Answer Seerr and Overseerr	`/sonarr` と `/radarr` をまとめてオン・オフします。	オフ
Make key / New key(新しいキー)	その側のキーを作ります。新しいキーを作ると、古いキーはすぐに使えなくなります。
Remove key(キーを削除)	その側のキーを削除します。そのキーを使っているアプリは拒否されます。
Let these apps delete files	オフの場合、アプリでタイトルを削除してもファイルは残ります。オンの場合、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 は、自分のログではクエリのキーを隠します。ただし、手前にあるリバースプロキシは、アドレス全体をログに残すことがあります。

キーのルール

それぞれの側に専用のキーがあり、このカードでしか作れません。HolyArrs の API キー(hak_ で始まるもの)はここでは使えません。また、ここのキーはほかの場所では使えません。
キーは、作った人として動作します。その人には、ライブラリを管理する権限が必要です。Prowlarr には、設定を変更する権限も必要です。
その人がオフにされるか、権限を失うと、だれかが新しいキーを作るまでアプリは拒否されます。カードに警告が表示されます。

HolyArrs API で管理する

パスワードでサインインした状態で使います。キーの呼び出しには、最近のパスワードでのサインインが必要です。

内容	呼び出し
スイッチ、アドレス、キーを読み取る	`GET /api/v1/settings/old-app-api`
オンにする	`PUT /api/v1/settings/old-app-api` に `{"enabled": true}` を付ける
アプリにファイルの削除を許可する	`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`)