Pular para o conteúdo
HolyArrsDocsHolyArrs.com

Rotas da API

Especialista

Chama, a partir dos teus próprios scripts, a mesma API JSON que a app web usa, em /api/v1.

Faz a tua primeira chamada

Ligação para Faz a tua primeira chamada
  1. Abre Settings > API > API keys (Definições > API > chaves de API) e cria uma chave só com os âmbitos de que precisa. Copia-a agora; só é mostrada uma vez.
  2. Envia-a no cabeçalho X-Api-Key em cada chamada. Nunca a ponhas no endereço.
  3. Chama o endereço base. Com um URL base de /holyarrs, é http://your-server:6262/holyarrs/api/v1.
Terminal window
export HOLYARRS_KEY=...your key...
curl -H "X-Api-Key: $HOLYARRS_KEY" "http://your-server:6262/api/v1/health"

Deves receber JSON de volta. Os erros vêm como {"error": "plain words"} com um estado HTTP. Os segredos voltam mascarados.

Settings > API mostra o endereço base, os âmbitos, exemplos de chamadas e todas as rotas com o respetivo âmbito. O ficheiro OpenAPI está em /api/v1/openapi.json quando tens a sessão iniciada.

Âmbitos

Ligação para Âmbitos
Âmbito Permite
health_read Só o feed de saúde, para ferramentas de monitorização.
read As rotas de leitura, incluindo o feed de saúde.
write Alterações, exceto rotas de administração e controlos.
admin Pessoas, convites, limites de pedidos, chaves de API, palavras-passe e autenticação de dois fatores, definições de início de sessão, restauro.
control Interruptores das Partes, fases, apps ligadas, reiniciar e encerrar.
all read, write e admin. Não inclui control.

O Seerr, o Bazarr e apps semelhantes usam antes a API das apps anteriores, com chaves próprias.

Se não funcionar

Ligação para Se não funcionar
Sintoma Causa Solução
401 em todas as chamadas Chave errada ou apagada Cria uma chave nova.
403 O âmbito da chave não cobre a rota Vê o âmbito da rota em Settings > API.
404 em todas as chamadas Falta o URL base Põe-no antes de /api/v1.

Para especialistas

Ligação para Para especialistas
Chamadas ao servidor de metadados

O HolyArrs obtém nomes, imagens e ids do servidor de metadados do HolyArrs. Aponta uma instalação para outro servidor com HOLYARRS_METADATA_URL; o código do servidor não está neste repositório.

Registo. Na primeira pesquisa, uma instalação chama POST /v1/installations sem corpo. A resposta é 201 com {"schema_version":1,"token":"hai_..."}. A app guarda o token cifrado e envia Authorization: Bearer <token> em cada pesquisa. Regista-se uma só vez; depois de um 401 não volta a registar-se, por isso uma instalação revogada continua revogada. Acima do limite por hora para cada grupo de endereços, a resposta é 429 registration_limit com Retry-After.

Pesquisa (todas GET) Rota
Pesquisa /v1/search?provider=tmdb&kind=movie&q=Example&page=1
Filme /v1/movies/tmdb/{id}
Série /v1/shows/{tmdb or tvmaze}/{id}
Temporada /v1/shows/tmdb/{id}/seasons/{n} (a temporada 0 são os especiais)
Música /v1/music/musicbrainz/{artist, release-group, release or recording}/{id}

Parâmetros desconhecidos ou repetidos são recusados. Os ids de um fornecedor nunca são usados noutro.

Uma boa resposta tem schema_version, source, source_id, fetched_at, expires_at, completeness, stale e data. Trata o HTML nos resumos como texto simples.

Estado Significa
400 Pedido inválido, não voltes a tentar
401 Token inválido ou revogado, não voltes a tentar
404 Esse registo não existe
429 Demasiadas chamadas, espera pelo Retry-After
503 Ocupado, espera e tenta mais uma vez
Adicionar uma rota

As rotas ficam no routes.go de cada módulo e são registadas com método, caminho e permissão, por isso não existe nenhuma rota sem uma verificação de permissão. O openapi.json vem das rotas e um teste falha quando deixam de coincidir. Depois de lançados, os caminhos e os nomes dos campos mantêm-se: acrescenta campos, não os renomeies.

Todas as rotas

Ligação para Todas as rotas

520 rotas. Volta a gerar com go run ./app/backend/tools/apidoc.

A coluna Permissão é a permissão de que quem chama precisa, tal como fixada no snapshot. A coluna Finalidade só está preenchida onde o registo da rota tem um comentário.

account

Ligação para account
Método Caminho Permissão Finalidade
PUT /api/v1/account/avatar self
DELETE /api/v1/account/avatar self

albums

Ligação para albums
Método Caminho Permissão Finalidade
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

Ligação para alerts
Método Caminho Permissão Finalidade
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

Ligação para app
Método Caminho Permissão Finalidade
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

Ligação para artists
Método Caminho Permissão Finalidade
POST /api/v1/artists manage_library
GET /api/v1/artists/lookup signed_in

artwork

Ligação para artwork
Método Caminho Permissão Finalidade
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

Ligação para ask-limits
Método Caminho Permissão Finalidade
GET /api/v1/ask-limits users
PUT /api/v1/ask-limits/{id} users

asked-by

Ligação para asked-by
Método Caminho Permissão Finalidade
GET /api/v1/asked-by signed_in

asks

Ligação para asks
Método Caminho Permissão Finalidade
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

Ligação para auth
Método Caminho Permissão Finalidade
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

Ligação para backups
Método Caminho Permissão Finalidade
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

Ligação para bridges
Método Caminho Permissão Finalidade
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

Ligação para calendar
Método Caminho Permissão Finalidade
GET /api/v1/calendar signed_in

collections

Ligação para collections
Método Caminho Permissão Finalidade
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

Ligação para data-packs
Método Caminho Permissão Finalidade
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

Ligação para discover
Método Caminho Permissão Finalidade
GET /api/v1/discover signed_in

downloaders

Ligação para downloaders
Método Caminho Permissão Finalidade
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

Ligação para downloads
Método Caminho Permissão Finalidade
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

Ligação para episodes
Método Caminho Permissão Finalidade
PUT /api/v1/episodes/{id} manage_library

events

Ligação para events
Método Caminho Permissão Finalidade
GET /api/v1/events manage_library

explore

Ligação para explore
Método Caminho Permissão Finalidade
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

Ligação para extras
Método Caminho Permissão Finalidade
GET /api/v1/extras/{kind}/{id} signed_in

files

Ligação para files
Método Caminho Permissão Finalidade
POST /api/v1/files/{id}/subtitles/choices manage_library
POST /api/v1/files/{id}/subtitles/choose manage_library

health

Ligação para health
Método Caminho Permissão Finalidade
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

Ligação para held
Método Caminho Permissão Finalidade
GET /api/v1/held manage_library
DELETE /api/v1/held manage_library
DELETE /api/v1/held/{id} manage_library

holding

Ligação para holding
Método Caminho Permissão Finalidade
GET /api/v1/holding manage_library
POST /api/v1/holding/clean manage_library
POST /api/v1/holding/restore manage_library

home

Ligação para home
Método Caminho Permissão Finalidade
GET /api/v1/home signed_in

imports

Ligação para imports
Método Caminho Permissão Finalidade
GET /api/v1/imports manage_library

jobs

Ligação para jobs
Método Caminho Permissão Finalidade
GET /api/v1/jobs manage_library
GET /api/v1/jobs/active manage_library
GET /api/v1/jobs/{id} manage_library

library

Ligação para library
Método Caminho Permissão Finalidade
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

Ligação para library-folders
Método Caminho Permissão Finalidade
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
Ligação para links
Método Caminho Permissão Finalidade
POST /api/v1/links/{kind}/{id}/restart users

live

Ligação para live
Método Caminho Permissão Finalidade
POST /api/v1/live/interest signed_in

logs

Ligação para logs
Método Caminho Permissão Finalidade
GET /api/v1/logs users
GET /api/v1/logs/download users

manual-import

Ligação para manual-import
Método Caminho Permissão Finalidade
POST /api/v1/manual-import settings
POST /api/v1/manual-import/scan settings

mcp

Ligação para mcp
Método Caminho Permissão Finalidade
GET /api/v1/mcp signed_in
POST /api/v1/mcp signed_in

media-servers

Ligação para media-servers
Método Caminho Permissão Finalidade
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

Ligação para messages
Método Caminho Permissão Finalidade
GET /api/v1/messages signed_in
POST /api/v1/messages/read signed_in

metadata

Ligação para metadata
Método Caminho Permissão Finalidade
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

Ligação para migrate
Método Caminho Permissão Finalidade
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

Ligação para music
Método Caminho Permissão Finalidade
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
Ligação para music-trending
Método Caminho Permissão Finalidade
GET /api/v1/music-trending signed_in
GET /api/v1/music-trending/art/{kind}/{mbid} signed_in

my

Ligação para my
Método Caminho Permissão Finalidade
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

Ligação para needs-decision
Método Caminho Permissão Finalidade
GET /api/v1/needs-decision manage_library
POST /api/v1/needs-decision/{id}/decide manage_library

never-add

Ligação para never-add
Método Caminho Permissão Finalidade
GET /api/v1/never-add manage_library
POST /api/v1/never-add manage_library
DELETE /api/v1/never-add/{id} manage_library

openapi.json

Ligação para openapi.json
Método Caminho Permissão Finalidade
GET /api/v1/openapi.json signed_in

outside-lists

Ligação para outside-lists
Método Caminho Permissão Finalidade
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

Ligação para own-traits
Método Caminho Permissão Finalidade
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

Ligação para parts
Método Caminho Permissão Finalidade
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

Ligação para people
Método Caminho Permissão Finalidade
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

Ligação para pick-rules
Método Caminho Permissão Finalidade
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

Ligação para public
Método Caminho Permissão Finalidade
GET /api/v1/public/signin-art public
GET /api/v1/public/signin-pic/t/p/{size}/{file} public Um padrão literal (= signinPicPath + “{size}/{file}”): os testes das rotas leem-no a partir do código-fonte.

releases

Ligação para releases
Método Caminho Permissão Finalidade
POST /api/v1/releases/{id}/choose manage_library
POST /api/v1/releases/{id}/turn-down manage_library

rename

Ligação para rename
Método Caminho Permissão Finalidade
GET /api/v1/rename manage_library
POST /api/v1/rename manage_library

reports

Ligação para reports
Método Caminho Permissão Finalidade
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

Ligação para schedules
Método Caminho Permissão Finalidade
GET /api/v1/schedules manage_library
PUT /api/v1/schedules/{kind} settings
POST /api/v1/schedules/{kind}/run manage_library
Ligação para search
Método Caminho Permissão Finalidade
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

Ligação para searches
Método Caminho Permissão Finalidade
GET /api/v1/searches manage_library

settings

Ligação para settings
Método Caminho Permissão Finalidade
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

Ligação para shows
Método Caminho Permissão Finalidade
POST /api/v1/shows manage_library
GET /api/v1/shows/lookup signed_in

sources

Ligação para sources
Método Caminho Permissão Finalidade
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

Ligação para stages
Método Caminho Permissão Finalidade
POST /api/v1/stages/{name}/pause users
POST /api/v1/stages/{name}/restart users
POST /api/v1/stages/{name}/resume users

subtitle-sites

Ligação para subtitle-sites
Método Caminho Permissão Finalidade
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

Ligação para subtitles
Método Caminho Permissão Finalidade
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

Ligação para support
Método Caminho Permissão Finalidade
GET /api/v1/support/bundle users

system

Ligação para system
Método Caminho Permissão Finalidade
POST /api/v1/system/key-kit owner

tags

Ligação para tags
Método Caminho Permissão Finalidade
GET /api/v1/tags manage_library

titles

Ligação para titles
Método Caminho Permissão Finalidade
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

Ligação para trailer
Método Caminho Permissão Finalidade
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

Ligação para turned-down
Método Caminho Permissão Finalidade
GET /api/v1/turned-down manage_library
DELETE /api/v1/turned-down manage_library
DELETE /api/v1/turned-down/{id} manage_library

users

Ligação para users
Método Caminho Permissão Finalidade
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

Ligação para watch-services
Método Caminho Permissão Finalidade
GET /api/v1/watch-services signed_in

wiki

Ligação para wiki
Método Caminho Permissão Finalidade
GET /api/v1/wiki/{kind}/{id} signed_in

other (outside /api/v1)

Ligação para other (outside /api/v1)
Método Caminho Permissão Finalidade
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 a página inicial responde-lhe com 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

O HolyArrs é gratuito. Se te poupou tempo, dá-lhe uma estrela no GitHub, patrocina-o ou oferece-me um café.