Маршруты API

Обращайтесь из своих скриптов к тому же JSON API, которым пользуется веб-приложение. Он находится по адресу /api/v1.

Первый вызов

1. Откройте Settings > API > API keys (Настройки > API > Ключи API) и создайте ключ только с теми областями доступа, которые ему нужны. Скопируйте его сразу: он показывается один раз.
2. Передавайте его в заголовке X-Api-Key при каждом вызове. Никогда не вставляйте его в адрес.
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	Только ленту исправности, для средств мониторинга.
read	Маршруты чтения, включая ленту исправности.
write	Изменения, кроме маршрутов администрирования и управления.
admin	Люди, приглашения, лимиты запросов, ключи API, пароли и двухфакторная защита, настройки входа, восстановление.
control	Переключатели Частей, этапы, связанные приложения, перезапуск и выключение.
all	read, write и admin. Без control.

Seerr, Bazarr и похожие приложения работают через API прежних приложений, у него свои ключи.

Если не работает

Признак проблемы	Причина	Решение
401 на каждый вызов	Ключ неверный или удалён	Создайте новый ключ.
403	Область доступа ключа не покрывает маршрут	Посмотрите область доступа маршрута на странице Settings > API.
404 на каждый вызов	Не указан URL base	Поставьте его перед /api/v1.

Для опытных

Вызовы сервера метаданных

HolyArrs получает названия, изображения и идентификаторы с сервера метаданных HolyArrs. Чтобы направить установку на другой сервер, задайте HOLYARRS_METADATA_URL; кода сервера в этом репозитории нет.

Регистрация. При первом обращении за данными установка вызывает POST /v1/installations без тела. В ответ приходит 201 с {"schema_version":1,"token":"hai_..."}. Приложение хранит токен зашифрованным и при каждом обращении отправляет 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}

Неизвестные и повторяющиеся параметры отклоняются. Идентификаторы одного поставщика данных никогда не используются для другого.

В хорошем ответе есть schema_version, source, source_id, fetched_at, expires_at, completeness, stale и data. HTML в описаниях считайте обычным текстом.

Код	Что значит
400	Неверный запрос, не повторяйте
401	Неверный или отозванный токен, не повторяйте
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

прочее (вне /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	стартовая страница отвечает на него кодом 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