API 路由

從你自己的腳本呼叫 Web 介面使用的同一套 JSON API，路徑在 /api/v1 底下。

發出第一個呼叫

1. 開啟 Settings > API > API keys（設定 > API > API 金鑰），建立一把金鑰，只勾選它需要的範圍。現在就複製下來，它只會顯示一次。
2. 每次呼叫都把金鑰放在 X-Api-Key header 裡。不要把它放進位址。
3. 呼叫基底位址。如果 URL base 是 /holyarrs，基底位址就是 http://your-server:6262/holyarrs/api/v1。

export HOLYARRS_KEY=...your key...
curl -H "X-Api-Key: $HOLYARRS_KEY" "http://your-server:6262/api/v1/health"

你應該會收到 JSON。錯誤的格式是 {"error": "plain words"}，並附上 HTTP 狀態碼。機密資料會以遮罩的形式回傳。

Settings > API 會顯示基底位址、各個範圍、呼叫範例，以及每個路由和它的範圍。登入後，OpenAPI 檔案在 /api/v1/openapi.json。

範圍

範圍	允許
health_read	只能讀取健康狀態 feed，給監控工具用。
read	讀取類的路由，包含健康狀態 feed。
write	各種變更，但不含管理員路由和控制類路由。
admin	使用者、邀請、請求額度、API 金鑰、密碼與兩步驟驗證、登入設定、還原。
control	功能區塊開關、階段、已連結的 App、重新啟動與關機。
all	read、write 和 admin。不含 control。

Seerr、Bazarr 這類 App 請改用舊 App API，它們有自己的金鑰。

如果沒有成功

症狀	原因	解決方式
每次呼叫都是 401	金鑰錯誤或已刪除	建立新的金鑰。
403	金鑰的範圍不包含這個路由	到 Settings > API 查看該路由的範圍。
每次呼叫都是 404	少了 URL base	把它放在 /api/v1 前面。

給進階使用者

中繼資料伺服器呼叫

HolyArrs 從 HolyArrs 中繼資料伺服器取得名稱、圖片和 id。要讓安裝指向其他伺服器，用 HOLYARRS_METADATA_URL；伺服器的程式碼不在這個 repo 裡。

註冊。 第一次查詢時，安裝會不帶內容呼叫 POST /v1/installations。回應是 201，內容為 {"schema_version":1,"token":"hai_..."}。App 會把 token 加密儲存，之後每次查詢都送出 Authorization: Bearer <token>。它只註冊一次；收到 401 後不會再註冊，所以被撤銷的安裝會一直維持撤銷。如果同一個位址群組超過每小時的上限，回應是 429 registration_limit，並附上 Retry-After。

查詢（全部是 GET）	路由
搜尋	/v1/search?provider=tmdb&kind=movie&q=Example&page=1
電影	/v1/movies/tmdb/{id}
影集	/v1/shows/{tmdb or tvmaze}/{id}
季	/v1/shows/tmdb/{id}/seasons/{n}（第 0 季是特別篇）
音樂	/v1/music/musicbrainz/{artist, release-group, release or recording}/{id}

未知或重複的參數會被拒絕。某個提供者的 id 絕不會拿去用在另一個提供者上。

正常的回應包含 schema_version、source、source_id、fetched_at、expires_at、completeness、stale 和 data。摘要裡的 HTML 要當成純文字處理。

狀態	意思
400	查詢有誤，不要重試
401	token 錯誤或已撤銷，不要重試
404	沒有這筆記錄
429	呼叫太多次，等 Retry-After 指定的時間
503	忙碌中，等一下再重試一次

新增路由

路由寫在每個模組的 routes.go 裡，註冊時要給方法、路徑和權限，所以不會有沒做權限檢查的路由。openapi.json 由這些路由產生，兩者不一致時測試會失敗。發布之後，路徑和欄位名稱就不再改：可以新增欄位，但不要重新命名。

所有路由

共 520 個路由。用 go run ./app/backend/tools/apidoc 重新產生。

「權限」欄是呼叫者需要的權限，與快照中固定的內容一致。「用途」欄只有在路由註冊處寫了註解時才會填。

account

方法	路徑	權限	用途
PUT	/api/v1/account/avatar	self
DELETE	/api/v1/account/avatar	self

albums

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
POST	/api/v1/artists	manage_library
GET	/api/v1/artists/lookup	signed_in

artwork

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/ask-limits	users
PUT	/api/v1/ask-limits/{id}	users

asked-by

方法	路徑	權限	用途
GET	/api/v1/asked-by	signed_in

asks

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/calendar	signed_in

collections

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/discover	signed_in

downloaders

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
PUT	/api/v1/episodes/{id}	manage_library

events

方法	路徑	權限	用途
GET	/api/v1/events	manage_library

explore

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/extras/{kind}/{id}	signed_in

files

方法	路徑	權限	用途
POST	/api/v1/files/{id}/subtitles/choices	manage_library
POST	/api/v1/files/{id}/subtitles/choose	manage_library

health

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/held	manage_library
DELETE	/api/v1/held	manage_library
DELETE	/api/v1/held/{id}	manage_library

holding

方法	路徑	權限	用途
GET	/api/v1/holding	manage_library
POST	/api/v1/holding/clean	manage_library
POST	/api/v1/holding/restore	manage_library

home

方法	路徑	權限	用途
GET	/api/v1/home	signed_in

imports

方法	路徑	權限	用途
GET	/api/v1/imports	manage_library

jobs

方法	路徑	權限	用途
GET	/api/v1/jobs	manage_library
GET	/api/v1/jobs/active	manage_library
GET	/api/v1/jobs/{id}	manage_library

library

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

links

方法	路徑	權限	用途
POST	/api/v1/links/{kind}/{id}/restart	users

live

方法	路徑	權限	用途
POST	/api/v1/live/interest	signed_in

logs

方法	路徑	權限	用途
GET	/api/v1/logs	users
GET	/api/v1/logs/download	users

manual-import

方法	路徑	權限	用途
POST	/api/v1/manual-import	settings
POST	/api/v1/manual-import/scan	settings

mcp

方法	路徑	權限	用途
GET	/api/v1/mcp	signed_in
POST	/api/v1/mcp	signed_in

media-servers

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/messages	signed_in
POST	/api/v1/messages/read	signed_in

metadata

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

music-trending

方法	路徑	權限	用途
GET	/api/v1/music-trending	signed_in
GET	/api/v1/music-trending/art/{kind}/{mbid}	signed_in

my

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/needs-decision	manage_library
POST	/api/v1/needs-decision/{id}/decide	manage_library

never-add

方法	路徑	權限	用途
GET	/api/v1/never-add	manage_library
POST	/api/v1/never-add	manage_library
DELETE	/api/v1/never-add/{id}	manage_library

openapi.json

方法	路徑	權限	用途
GET	/api/v1/openapi.json	signed_in

outside-lists

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/public/signin-art	public
GET	/api/v1/public/signin-pic/t/p/{size}/{file}	public	字面上的路徑樣式（= signinPicPath + “{size}/{file}”）：路由測試會從原始碼讀取它。

releases

方法	路徑	權限	用途
POST	/api/v1/releases/{id}/choose	manage_library
POST	/api/v1/releases/{id}/turn-down	manage_library

rename

方法	路徑	權限	用途
GET	/api/v1/rename	manage_library
POST	/api/v1/rename	manage_library

reports

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/schedules	manage_library
PUT	/api/v1/schedules/{kind}	settings
POST	/api/v1/schedules/{kind}/run	manage_library

search

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/searches	manage_library

settings

方法	路徑	權限	用途
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

方法	路徑	權限	用途
POST	/api/v1/shows	manage_library
GET	/api/v1/shows/lookup	signed_in

sources

方法	路徑	權限	用途
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

方法	路徑	權限	用途
POST	/api/v1/stages/{name}/pause	users
POST	/api/v1/stages/{name}/restart	users
POST	/api/v1/stages/{name}/resume	users

subtitle-sites

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/support/bundle	users

system

方法	路徑	權限	用途
POST	/api/v1/system/key-kit	owner

tags

方法	路徑	權限	用途
GET	/api/v1/tags	manage_library

titles

方法	路徑	權限	用途
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

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/turned-down	manage_library
DELETE	/api/v1/turned-down	manage_library
DELETE	/api/v1/turned-down/{id}	manage_library

users

方法	路徑	權限	用途
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

方法	路徑	權限	用途
GET	/api/v1/watch-services	signed_in

wiki

方法	路徑	權限	用途
GET	/api/v1/wiki/{kind}/{id}	signed_in

other（不在 /api/v1 底下）

方法	路徑	權限	用途
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	start page 會用 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