REST API Reference
This page is generated from the @Controller / @Get / @RequirePermissions decorators in apps/backend/src at build time. Do not edit it by hand — change the source and rebuild. This guarantees the reference always matches the code that ships.
Every endpoint below was read from the controllers themselves, including the exact permission its guard enforces.
- 468 endpoints across 24 controllers
- Base URL:
http://<host>:<port>/api
Authentication
All endpoints except /api/auth/login require a Bearer token.
# 1. Log in to get an access token
curl -s -X POST http://localhost:8080/api/auth/login \
-H 'Content-Type: application/json' \
-d '{"username":"admin","password":"<password>"}'
# → { "accessToken": "eyJ...", "refreshToken": "..." }
# 2. Use it
curl -s http://localhost:8080/api/torrents \
-H 'Authorization: Bearer eyJ...'
Access tokens are short-lived; use the refresh token to rotate. See Authentication.
Authorization
Each endpoint declares a permission (the Permission column below). A token whose role
lacks that permission gets 403 Forbidden. The full catalogue is in the
Permissions Reference.
Common status codes
| Code | Meaning |
|---|---|
200 / 201 | Success |
400 | Validation failed (bad body/query) |
401 | Missing or expired token |
403 | Token valid, but the role lacks the required permission |
404 | Resource does not exist |
500 | Server error — check logs |
Client examples
- cURL
- TypeScript
- Python
- PowerShell
curl -s http://localhost:8080/api/torrents -H "Authorization: Bearer $TOKEN"
const res = await fetch('http://localhost:8080/api/torrents', {
headers: { Authorization: `Bearer ${token}` },
});
if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
const torrents = await res.json();
import requests
r = requests.get(
"http://localhost:8080/api/torrents",
headers={"Authorization": f"Bearer {token}"},
timeout=30,
)
r.raise_for_status()
torrents = r.json()
$headers = @{ Authorization = "Bearer $Token" }
Invoke-RestMethod -Uri "http://localhost:8080/api/torrents" -Headers $headers
/account/notifications
From AccountNotificationsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/account/notifications/events | NOTIFICATIONS_VIEW_OWN | listEvents |
GET | /api/account/notifications/preferences | NOTIFICATIONS_VIEW_OWN | listPreferences |
PUT | /api/account/notifications/preferences/:eventKey | NOTIFICATIONS_MANAGE_OWN | updatePreference |
POST | /api/account/notifications/preferences/bulk | NOTIFICATIONS_MANAGE_OWN | bulkUpdate |
GET | /api/account/notifications/channels | NOTIFICATIONS_VIEW_OWN | listChannels |
POST | /api/account/notifications/channels/telegram/link | NOTIFICATIONS_CHANNELS_MANAGE_OWN | linkTelegram |
POST | /api/account/notifications/channels/telegram/confirm | NOTIFICATIONS_CHANNELS_MANAGE_OWN | confirmTelegram |
POST | /api/account/notifications/channels/email | NOTIFICATIONS_CHANNELS_MANAGE_OWN | connectEmail |
POST | /api/account/notifications/channels/discord | NOTIFICATIONS_CHANNELS_MANAGE_OWN | connectDiscord |
POST | /api/account/notifications/channels/:type/test | NOTIFICATIONS_CHANNELS_MANAGE_OWN | testChannel |
DELETE | /api/account/notifications/channels/:type | NOTIFICATIONS_CHANNELS_MANAGE_OWN | disconnect |
POST | /api/account/notifications/channels/telegram/bot | NOTIFICATIONS_CHANNELS_MANAGE_OWN | setTelegramBot |
GET | /api/account/notifications/inbox | NOTIFICATIONS_VIEW_OWN | listInbox |
GET | /api/account/notifications/inbox/unread-count | NOTIFICATIONS_VIEW_OWN | unreadCount |
POST | /api/account/notifications/inbox/mark-all-read | NOTIFICATIONS_MANAGE_OWN | markAllRead |
POST | /api/account/notifications/inbox/:id/read | NOTIFICATIONS_MANAGE_OWN | markRead |
POST | /api/account/notifications/inbox/:id/unread | NOTIFICATIONS_MANAGE_OWN | markUnread |
POST | /api/account/notifications/inbox/:id/archive | NOTIFICATIONS_MANAGE_OWN | archive |
/audit
From AuditController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/audit | AUDIT_VIEW | list |
/auth
From AuthController.
| Method | Path | Permission | Handler |
|---|---|---|---|
POST | /api/auth/login | — | login |
POST | /api/auth/refresh | — | refresh |
POST | /api/auth/logout | — | logout |
GET | /api/auth/me | — | me |
POST | /api/auth/change-password | — | changePassword |
/context-actions
From ContextActionsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/context-actions/catalog | — | catalog |
/engines
From EngineController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/engines | SYSTEM_VIEW | list |
GET | /api/engines/health | SYSTEM_VIEW | health |
POST | /api/engines/test | ENGINES_MANAGE | test |
POST | /api/engines | ENGINES_MANAGE | create |
PATCH | /api/engines/:id | ENGINES_MANAGE | update |
DELETE | /api/engines/:id | ENGINES_MANAGE | remove |
/files
From FilesController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/files | FILES_VIEW | browse |
GET | /api/files/root | FILES_VIEW | root |
PUT | /api/files/root | SETTINGS_MANAGE_ROOT_PATH | setRoot |
GET | /api/files/properties | FILES_VIEW | properties |
GET | /api/files/preview | FILES_PREVIEW | preview |
POST | /api/files/media-ticket | FILES_PREVIEW | mediaTicket |
GET | /api/files/stream | — | stream |
GET | /api/files/download | FILES_DOWNLOAD | download |
GET | /api/files/inspect | FILES_VIEW | inspect |
POST | /api/files/folders | FILES_CREATE_FOLDER | createFolder |
POST | /api/files/ensure-dir | FILES_CREATE_FOLDER | ensureDir |
POST | /api/files/rename | FILES_RENAME | rename |
POST | /api/files/move | FILES_MOVE | move |
POST | /api/files/copy | FILES_COPY | copy |
POST | /api/files/delete/preview | FILES_DELETE | previewDelete |
POST | /api/files/bulk/delete-preview | FILES_DELETE | previewBulkDelete |
POST | /api/files/delete | FILES_DELETE | remove |
POST | /api/files/bulk | FILES_BULK_ACTIONS | bulk |
POST | /api/files/move-conflicts | FILES_VIEW | moveConflicts |
POST | /api/files/resolve-conflicts | FILES_MOVE, FILES_COPY, FILES_DELETE | resolveConflicts |
POST | /api/files/cleanup-preview | FILES_CLEANUP | cleanupPreview |
POST | /api/files/cleanup-execute | FILES_CLEANUP | cleanupExecute |
GET | /api/files/trash | FILES_VIEW | listTrash |
POST | /api/files/trash/restore | FILES_DELETE | restore |
POST | /api/files/trash/purge | FILES_DELETE | purge |
POST | /api/files/trash/empty | FILES_DELETE | empty |
/indexers
From IndexersController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/indexers | INDEXERS_VIEW | list |
GET | /api/indexers/:id | INDEXERS_VIEW | get |
POST | /api/indexers | INDEXERS_MANAGE | create |
PATCH | /api/indexers/:id | INDEXERS_MANAGE | update |
DELETE | /api/indexers/:id | INDEXERS_MANAGE | remove |
POST | /api/indexers/:id/test | INDEXERS_TEST | test |
GET | /api/indexers/:id/search | INDEXERS_TEST | search |
/integrations/prowlarr
From ProwlarrController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/integrations/prowlarr | INTEGRATIONS_PROWLARR_VIEW | get |
PATCH | /api/integrations/prowlarr | INTEGRATIONS_PROWLARR_MANAGE | update |
POST | /api/integrations/prowlarr/test | INTEGRATIONS_PROWLARR_TEST | test |
GET | /api/integrations/prowlarr/status | INTEGRATIONS_PROWLARR_VIEW | status |
POST | /api/integrations/prowlarr/open | INTEGRATIONS_PROWLARR_OPEN | open |
/jobs
From JobsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/jobs | — | list |
/jobs
From PlatformJobsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/jobs/overview | JOBS_VIEW | overview |
GET | /api/jobs/catalog | JOBS_VIEW | catalog |
GET | /api/jobs/list | JOBS_VIEW | list |
GET | /api/jobs/schedules | JOBS_VIEW | scheduleList |
GET | /api/jobs/workers | JOBS_VIEW_WORKERS | workerList |
GET | /api/jobs/settings | JOBS_MANAGE_SETTINGS | settings |
GET | /api/jobs/:id | JOBS_VIEW | detail |
GET | /api/jobs/:id/events | JOBS_VIEW | events |
GET | /api/jobs/:id/children | JOBS_VIEW | children |
POST | /api/jobs/bulk/cancel | JOBS_BULK_MANAGE, JOBS_CANCEL | bulkCancel |
POST | /api/jobs/bulk/retry | JOBS_BULK_MANAGE, JOBS_RETRY | bulkRetry |
POST | /api/jobs/bulk/rerun | JOBS_BULK_MANAGE, JOBS_RERUN | bulkRerun |
POST | /api/jobs/:id/cancel | JOBS_CANCEL | cancel |
POST | /api/jobs/:id/pause | JOBS_PAUSE | pause |
POST | /api/jobs/:id/resume | JOBS_RESUME | resume |
POST | /api/jobs/:id/retry | JOBS_RETRY | retry |
POST | /api/jobs/:id/rerun | JOBS_RERUN | rerun |
/media
From MediaController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media/repair/movie-identity/preview | MEDIA_MANAGER_VIEW | previewIdentityRepair |
POST | /api/media/repair/movie-identity/apply | MEDIA_MANAGER_MANAGE_LIBRARIES | applyIdentityRepair |
GET | /api/media/dashboard | MEDIA_MANAGER_VIEW | dashboard |
GET | /api/media/health | MEDIA_MANAGER_VIEW | health |
GET | /api/media/libraries | MEDIA_MANAGER_VIEW | listLibraries |
GET | /api/media/libraries/watch-status | MEDIA_MANAGER_VIEW | watchStatus |
POST | /api/media/libraries | MEDIA_MANAGER_MANAGE_LIBRARIES | createLibrary |
PATCH | /api/media/libraries/:id | MEDIA_MANAGER_MANAGE_LIBRARIES | updateLibrary |
DELETE | /api/media/libraries/:id | MEDIA_MANAGER_MANAGE_LIBRARIES | removeLibrary |
POST | /api/media/libraries/:id/scan | MEDIA_MANAGER_SCAN | scanLibrary |
POST | /api/media/libraries/:id/organize | MEDIA_MANAGER_RENAME | organizeLibrary |
GET | /api/media/items/alphabet | MEDIA_MANAGER_VIEW | itemAlphabet |
GET | /api/media/items | MEDIA_MANAGER_VIEW | listItems |
GET | /api/media/series | MEDIA_MANAGER_VIEW | listSeries |
GET | /api/media/series/episodes | MEDIA_MANAGER_VIEW | seriesEpisodes |
GET | /api/media/libraries/:id/consistency | MEDIA_MANAGER_VIEW | checkConsistency |
GET | /api/media/series/health | MEDIA_MANAGER_VIEW | seriesHealth |
GET | /api/media/items/issues | MEDIA_MANAGER_VIEW | issueCounts |
GET | /api/media/items/export.csv | MEDIA_MANAGER_EXPORT | exportItems |
GET | /api/media/items/:id | MEDIA_MANAGER_VIEW | getItem |
PATCH | /api/media/items/:id | MEDIA_MANAGER_EDIT_METADATA | updateItem |
POST | /api/media/items/reidentify | MEDIA_MANAGER_MATCH | reidentifyItems |
POST | /api/media/items/bulk/metadata | MEDIA_MANAGER_EDIT_METADATA | bulkRefreshMetadata |
POST | /api/media/items/bulk/lock | MEDIA_MANAGER_EDIT_METADATA | bulkLock |
POST | /api/media/items/bulk/unlock | MEDIA_MANAGER_EDIT_METADATA | bulkUnlock |
POST | /api/media/items/bulk/remove | MEDIA_MANAGER_DELETE | bulkRemove |
POST | /api/media/items/bulk/delete-files/preview | MEDIA_MANAGER_DELETE_FILES | previewDeleteFiles |
POST | /api/media/items/bulk/delete-files | MEDIA_MANAGER_DELETE_FILES | bulkDeleteFiles |
POST | /api/media/items/bulk/move | MEDIA_MANAGER_MOVE_FILES | bulkMove |
POST | /api/media/items/bulk/nfo | MEDIA_MANAGER_GENERATE_NFO | bulkNfo |
POST | /api/media/items/:id/match | MEDIA_MANAGER_MATCH | matchItem |
POST | /api/media/items/:id/unmatch | MEDIA_MANAGER_MATCH | unmatchItem |
POST | /api/media/items/:id/lock | MEDIA_MANAGER_EDIT_METADATA | lockItem |
POST | /api/media/items/:id/unlock | MEDIA_MANAGER_EDIT_METADATA | unlockItem |
POST | /api/media/items/:id/metadata/fetch | MEDIA_MANAGER_EDIT_METADATA | fetchMetadata |
PATCH | /api/media/items/:id/metadata | MEDIA_MANAGER_EDIT_METADATA | updateMetadata |
GET | /api/media/shows/by-key | MEDIA_MANAGER_VIEW | showByKey |
POST | /api/media/shows/:id/metadata/refresh | MEDIA_MANAGER_EDIT_METADATA | refreshShowMetadata |
PATCH | /api/media/shows/:id/identity | MEDIA_MANAGER_EDIT_METADATA | setShowIdentity |
PATCH | /api/media/shows/:id/metadata | MEDIA_MANAGER_EDIT_METADATA | updateShowMetadata |
PATCH | /api/media/shows/:id/seasons/:seasonNumber | MEDIA_MANAGER_EDIT_METADATA | updateSeason |
GET | /api/media/shows/:id/artwork | MEDIA_MANAGER_VIEW | listShowArtwork |
POST | /api/media/shows/:id/artwork/select | MEDIA_MANAGER_MANAGE_ARTWORK | selectShowArtwork |
POST | /api/media/shows/:id/artwork/upload | MEDIA_MANAGER_MANAGE_ARTWORK | uploadShowArtwork |
POST | /api/media/shows/:id/artwork/import | MEDIA_MANAGER_MANAGE_ARTWORK | importShowArtwork |
GET | /api/media/items/:id/artwork | MEDIA_MANAGER_VIEW | listArtwork |
POST | /api/media/items/:id/artwork/select | MEDIA_MANAGER_MANAGE_ARTWORK | selectArtwork |
POST | /api/media/items/:id/artwork/upload | MEDIA_MANAGER_MANAGE_ARTWORK | uploadArtwork |
POST | /api/media/items/:id/artwork/import | MEDIA_MANAGER_MANAGE_ARTWORK | importArtwork |
GET | /api/media/items/:id/artwork/missing | MEDIA_MANAGER_VIEW | missingArtwork |
GET | /api/media/artwork/:artworkId/image | MEDIA_MANAGER_VIEW | `` |
GET | /api/media/items/:id/subtitles | MEDIA_MANAGER_VIEW | listSubtitles |
POST | /api/media/items/:id/subtitles/scan | MEDIA_MANAGER_MANAGE_SUBTITLES | scanSubtitles |
GET | /api/media/items/:id/subtitles/missing | MEDIA_MANAGER_VIEW | missingSubtitles |
POST | /api/media/nfo/generate | MEDIA_MANAGER_GENERATE_NFO | generateNfo |
GET | /api/media/duplicates/overview | MEDIA_MANAGER_VIEW | duplicatesOverview |
GET | /api/media/duplicates | MEDIA_MANAGER_VIEW | listDuplicates |
POST | /api/media/duplicates/detect | MEDIA_MANAGER_SCAN | detectDuplicates |
POST | /api/media/duplicates/restore-suffixes | MEDIA_MANAGER_RENAME | restoreOrphanedSuffixes |
POST | /api/media/jobs/:jobId/cancel | MEDIA_MANAGER_SCAN | cancelJob |
GET | /api/media/duplicates/quick-clean/candidates | MEDIA_MANAGER_VIEW | quickCleanCandidates |
GET | /api/media/duplicates/trash/history | MEDIA_MANAGER_VIEW | duplicateTrashHistory |
POST | /api/media/duplicates/bulk/preview | MEDIA_MANAGER_VIEW | bulkPreviewDuplicates |
POST | /api/media/duplicates/bulk/resolve | MEDIA_MANAGER_DELETE | bulkResolveDuplicates |
POST | /api/media/duplicates/resolutions/:resolutionId/resolve | MEDIA_MANAGER_DELETE | resolveDuplicateCleanup |
GET | /api/media/duplicates/:groupId | MEDIA_MANAGER_VIEW | getDuplicateGroup |
POST | /api/media/duplicates/:groupId/ignore | MEDIA_MANAGER_MATCH | ignoreDuplicateGroup |
POST | /api/media/duplicates/:groupId/preview | MEDIA_MANAGER_VIEW | previewDuplicateCleanup |
POST | /api/media/duplicates/:groupId/preview-delete | MEDIA_MANAGER_VIEW | previewDuplicateItemDeletion |
POST | /api/media/duplicates/:groupId/reopen | MEDIA_MANAGER_MATCH | reopenDuplicateGroup |
GET | /api/media/shows/duplicates | MEDIA_MANAGER_VIEW | detectDuplicateShows |
POST | /api/media/shows/duplicates/preview | MEDIA_MANAGER_VIEW | previewShowMerge |
POST | /api/media/shows/duplicates/merge | MEDIA_MANAGER_RENAME, MEDIA_MANAGER_DELETE | mergeShows |
GET | /api/media/shows/:id | MEDIA_MANAGER_VIEW | showDetail |
GET | /api/media/server-integrations | MEDIA_MANAGER_MANAGE_INTEGRATIONS | listIntegrations |
POST | /api/media/server-integrations | MEDIA_MANAGER_MANAGE_INTEGRATIONS | createIntegration |
PATCH | /api/media/server-integrations/:id | MEDIA_MANAGER_MANAGE_INTEGRATIONS | updateIntegration |
DELETE | /api/media/server-integrations/:id | MEDIA_MANAGER_MANAGE_INTEGRATIONS | removeIntegration |
POST | /api/media/server-integrations/:id/test | MEDIA_MANAGER_MANAGE_INTEGRATIONS | testIntegration |
POST | /api/media/server-integrations/:id/refresh | MEDIA_MANAGER_MANAGE_INTEGRATIONS | refreshIntegration |
POST | /api/media/providers/tmdb/test | SETTINGS_MANAGE | testTmdbApi |
POST | /api/media/providers/tvdb/test | SETTINGS_MANAGE | testTvdbApi |
GET | /api/media/providers | MEDIA_MANAGER_VIEW | listProviders |
GET | /api/media/providers/imdb/status | MEDIA_MANAGER_IMDB_VIEW | imdbStatus |
GET | /api/media/providers/imdb/settings | MEDIA_MANAGER_IMDB_VIEW | imdbSettings |
PATCH | /api/media/providers/imdb/settings | MEDIA_MANAGER_IMDB_CONFIGURE | updateImdbSettings |
POST | /api/media/providers/imdb/test | MEDIA_MANAGER_IMDB_CONFIGURE | testImdbApi |
POST | /api/media/providers/imdb/dataset/validate | MEDIA_MANAGER_IMDB_IMPORT_DATASET | validateImdbDataset |
POST | /api/media/providers/imdb/dataset/import | MEDIA_MANAGER_IMDB_IMPORT_DATASET | importImdbDataset |
POST | /api/media/providers/imdb/dataset/import/stop | MEDIA_MANAGER_IMDB_IMPORT_DATASET | stopImdbImport |
POST | /api/media/providers/imdb/dataset/update-now | MEDIA_MANAGER_IMDB_IMPORT_DATASET | updateImdbDatasetNow |
POST | /api/media/providers/imdb/dataset/reset | MEDIA_MANAGER_IMDB_IMPORT_DATASET | resetImdbData |
GET | /api/media/providers/imdb/dataset/imports | MEDIA_MANAGER_IMDB_VIEW | imdbImports |
GET | /api/media/providers/imdb/search | MEDIA_MANAGER_IMDB_SEARCH | imdbSearch |
GET | /api/media/providers/imdb/title/:imdbId | MEDIA_MANAGER_IMDB_VIEW | imdbTitle |
POST | /api/media/items/:id/match/imdb | MEDIA_MANAGER_IMDB_MATCH | matchItemImdb |
GET | /api/media/presets | MEDIA_MANAGER_VIEW | presets |
POST | /api/media/preview | MEDIA_MANAGER_VIEW | preview |
POST | /api/media/apply | MEDIA_MANAGER_RENAME | apply |
GET | /api/media/rename/undoable | MEDIA_MANAGER_RENAME | undoableRuns |
GET | /api/media/rename/undoable/:runId | MEDIA_MANAGER_RENAME | runOperations |
POST | /api/media/rename/undo | MEDIA_MANAGER_RENAME | undoRename |
GET | /api/media/history | MEDIA_MANAGER_VIEW | history |
GET | /api/media/settings/cleanup | MEDIA_MANAGER_VIEW | getCleanup |
PATCH | /api/media/settings/cleanup | MEDIA_MANAGER_MANAGE_LIBRARIES | updateCleanup |
GET | /api/media/settings/seeding-torrent | MEDIA_MANAGER_VIEW | getSeedingTorrentPolicy |
PATCH | /api/media/settings/seeding-torrent | MEDIA_MANAGER_MANAGE_LIBRARIES | updateSeedingTorrentPolicy |
/media-acquisition
From MediaAcquisitionController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media-acquisition/overview | MEDIA_ACQUISITION_VIEW | overview |
GET | /api/media-acquisition/watchlist | MEDIA_ACQUISITION_VIEW | listWatchlist |
GET | /api/media-acquisition/watchlist/library-series | MEDIA_ACQUISITION_VIEW | librarySeries |
POST | /api/media-acquisition/watchlist/library/resolve-imdb | MEDIA_ACQUISITION_MANAGE_WATCHLIST | resolveLibraryImdbIds |
POST | /api/media-acquisition/watchlist/bulk | MEDIA_ACQUISITION_MANAGE_WATCHLIST | bulkAddWatchlist |
POST | /api/media-acquisition/watchlist | MEDIA_ACQUISITION_MANAGE_WATCHLIST | createWatchlist |
GET | /api/media-acquisition/watchlist/:id | MEDIA_ACQUISITION_VIEW | getWatchlist |
PATCH | /api/media-acquisition/watchlist/:id | MEDIA_ACQUISITION_MANAGE_WATCHLIST | updateWatchlist |
DELETE | /api/media-acquisition/watchlist/:id | MEDIA_ACQUISITION_MANAGE_WATCHLIST | deleteWatchlist |
GET | /api/media-acquisition/profiles | MEDIA_ACQUISITION_VIEW | listProfiles |
POST | /api/media-acquisition/profiles | MEDIA_ACQUISITION_MANAGE_PROFILES | createProfile |
GET | /api/media-acquisition/profiles/:id | MEDIA_ACQUISITION_VIEW | getProfile |
PATCH | /api/media-acquisition/profiles/:id | MEDIA_ACQUISITION_MANAGE_PROFILES | updateProfile |
DELETE | /api/media-acquisition/profiles/:id | MEDIA_ACQUISITION_MANAGE_PROFILES | deleteProfile |
GET | /api/media-acquisition/match-preferences | MEDIA_ACQUISITION_VIEW | listMatchPreferences |
POST | /api/media-acquisition/match-preferences | MEDIA_ACQUISITION_MANAGE_PROFILES | createMatchPreference |
PATCH | /api/media-acquisition/match-preferences/:id | MEDIA_ACQUISITION_MANAGE_PROFILES | updateMatchPreference |
DELETE | /api/media-acquisition/match-preferences/:id | MEDIA_ACQUISITION_MANAGE_PROFILES | deleteMatchPreference |
POST | /api/media-acquisition/evaluate | MEDIA_ACQUISITION_EVALUATE | evaluate |
POST | /api/media-acquisition/simulate | MEDIA_ACQUISITION_VIEW | simulate |
GET | /api/media-acquisition/evaluations | MEDIA_ACQUISITION_VIEW | listEvaluations |
GET | /api/media-acquisition/evaluations/:id | MEDIA_ACQUISITION_VIEW | getEvaluation |
GET | /api/media-acquisition/waiting | MEDIA_ACQUISITION_VIEW | waiting |
GET | /api/media-acquisition/upgrades | MEDIA_ACQUISITION_VIEW | upgrades |
GET | /api/media-acquisition/rejected | MEDIA_ACQUISITION_VIEW | rejected |
GET | /api/media-acquisition/approval-queue | MEDIA_ACQUISITION_VIEW | approvalQueue |
POST | /api/media-acquisition/evaluations/:id/approve | MEDIA_ACQUISITION_APPROVE | approve |
POST | /api/media-acquisition/evaluations/:id/reject | MEDIA_ACQUISITION_REJECT | reject |
POST | /api/media-acquisition/evaluations/:id/override | MEDIA_ACQUISITION_OVERRIDE | override |
GET | /api/media-acquisition/missing-episodes | MEDIA_ACQUISITION_VIEW | missingEpisodesOverview |
GET | /api/media-acquisition/missing-episodes/:watchlistItemId | MEDIA_ACQUISITION_VIEW | missingEpisodesForSeries |
POST | /api/media-acquisition/missing-episodes/scan | MEDIA_ACQUISITION_MANAGE_WATCHLIST | scanMissingEpisodes |
POST | /api/media-acquisition/missing-episodes/series/:watchlistItemId/search | MEDIA_ACQUISITION_EVALUATE | searchMissingEpisodesForSeries |
POST | /api/media-acquisition/missing-episodes/:id/search | MEDIA_ACQUISITION_EVALUATE | searchMissingEpisode |
POST | /api/media-acquisition/missing-episodes/:id/ignore | MEDIA_ACQUISITION_MANAGE_WATCHLIST | ignoreMissingEpisode |
POST | /api/media-acquisition/missing-episodes/:id/unignore | MEDIA_ACQUISITION_MANAGE_WATCHLIST | unignoreMissingEpisode |
GET | /api/media-acquisition/missing-episodes/:watchlistItemId/seasons | MEDIA_ACQUISITION_VIEW | missingSeasons |
GET | /api/media-acquisition/missing-movies | MEDIA_ACQUISITION_VIEW | missingMoviesOverview |
POST | /api/media-acquisition/missing-movies/scan | MEDIA_ACQUISITION_MANAGE_WATCHLIST | scanMissingMovies |
POST | /api/media-acquisition/missing-movies/:id/ignore | MEDIA_ACQUISITION_MANAGE_WATCHLIST | ignoreMissingMovie |
POST | /api/media-acquisition/missing-movies/:id/unignore | MEDIA_ACQUISITION_MANAGE_WATCHLIST | unignoreMissingMovie |
GET | /api/media-acquisition/history | MEDIA_ACQUISITION_HISTORY | history |
GET | /api/media-acquisition/recommendations | MEDIA_ACQUISITION_VIEW | recommendations |
GET | /api/media-acquisition/settings | MEDIA_ACQUISITION_SETTINGS | getSettings |
PATCH | /api/media-acquisition/settings | MEDIA_ACQUISITION_SETTINGS | updateSettings |
POST | /api/media-acquisition/export | MEDIA_ACQUISITION_EXPORT | export |
/media-server-analytics
From MediaServerAnalyticsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media-server-analytics/dashboard | MEDIA_SERVER_ANALYTICS_VIEW | dashboard |
GET | /api/media-server-analytics/live | MEDIA_SERVER_ANALYTICS_VIEW_LIVE_ACTIVITY | live |
POST | /api/media-server-analytics/live/poll | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | pollLive |
GET | /api/media-server-analytics/live/:id/artwork | MEDIA_SERVER_ANALYTICS_VIEW_LIVE_ACTIVITY | liveArtwork |
GET | /api/media-server-analytics/notifications/:notificationId/artwork | MEDIA_SERVER_ANALYTICS_VIEW_LIVE_ACTIVITY | notificationArtwork |
GET | /api/media-server-analytics/watch-history | MEDIA_SERVER_ANALYTICS_VIEW_HISTORY | watchHistory |
GET | /api/media-server-analytics/reports/usage | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportUsage |
GET | /api/media-server-analytics/reports/users | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportUsers |
GET | /api/media-server-analytics/reports/libraries | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportLibraries |
GET | /api/media-server-analytics/reports/playback | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportPlayback |
GET | /api/media-server-analytics/reports/top-media | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportTopMedia |
GET | /api/media-server-analytics/reports/devices | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportDevices |
GET | /api/media-server-analytics/reports/heatmap | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportHeatmap |
GET | /api/media-server-analytics/reports/trends | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportTrends |
GET | /api/media-server-analytics/reports/resolutions | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportResolutions |
GET | /api/media-server-analytics/reports/plays | MEDIA_SERVER_ANALYTICS_VIEW_HISTORY | reportPlays |
GET | /api/media-server-analytics/reports/library-growth | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportLibraryGrowth |
GET | /api/media-server-analytics/reports/bandwidth | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | reportBandwidth |
GET | /api/media-server-analytics/export/watch-history | MEDIA_SERVER_ANALYTICS_EXPORT | exportWatchHistory |
GET | /api/media-server-analytics/meta/libraries | MEDIA_SERVER_ANALYTICS_VIEW | metaLibraries |
GET | /api/media-server-analytics/meta/users | MEDIA_SERVER_ANALYTICS_VIEW | metaUsers |
GET | /api/media-server-analytics/meta/sync-runs | MEDIA_SERVER_ANALYTICS_VIEW_REPORTS | metaSyncRuns |
POST | /api/media-server-analytics/meta/sync | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | runSync |
GET | /api/media-server-analytics/users | MEDIA_SERVER_ANALYTICS_VIEW_USERS | users |
GET | /api/media-server-analytics/recently-added | MEDIA_SERVER_ANALYTICS_VIEW | recentlyAdded |
GET | /api/media-server-analytics/import-sources | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | listImportSources |
POST | /api/media-server-analytics/import-sources | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | createImportSource |
GET | /api/media-server-analytics/import-sources/:id | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | getImportSource |
PATCH | /api/media-server-analytics/import-sources/:id | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | updateImportSource |
DELETE | /api/media-server-analytics/import-sources/:id | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | deleteImportSource |
POST | /api/media-server-analytics/import-sources/:id/test | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | testImportSource |
POST | /api/media-server-analytics/import-sources/:id/preview | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | previewImport |
POST | /api/media-server-analytics/import-sources/:id/import | MEDIA_SERVER_ANALYTICS_RUN_IMPORTS | runImport |
GET | /api/media-server-analytics/import-jobs | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | listImportJobs |
GET | /api/media-server-analytics/import-jobs/:id | MEDIA_SERVER_ANALYTICS_MANAGE_IMPORTS | getImportJob |
GET | /api/media-server-analytics/newsletters | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | listNewsletters |
GET | /api/media-server-analytics/newsletters/recipient-options | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | newsletterRecipientOptions |
PATCH | /api/media-server-analytics/newsletters/recipient-options/:userId | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | setRecipientEmail |
POST | /api/media-server-analytics/newsletters | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | createNewsletter |
GET | /api/media-server-analytics/newsletters/:id | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | getNewsletter |
PATCH | /api/media-server-analytics/newsletters/:id | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | updateNewsletter |
DELETE | /api/media-server-analytics/newsletters/:id | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | deleteNewsletter |
POST | /api/media-server-analytics/newsletters/:id/preview | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | previewNewsletter |
POST | /api/media-server-analytics/newsletters/:id/test-send | MEDIA_SERVER_ANALYTICS_SEND_NEWSLETTERS | testSendNewsletter |
POST | /api/media-server-analytics/newsletters/:id/send-now | MEDIA_SERVER_ANALYTICS_SEND_NEWSLETTERS | sendNewsletter |
GET | /api/media-server-analytics/newsletters/:id/deliveries | MEDIA_SERVER_ANALYTICS_MANAGE_NEWSLETTERS | newsletterDeliveries |
GET | /api/media-server-analytics/settings/email | MEDIA_SERVER_ANALYTICS_MANAGE_SETTINGS | getEmailSettings |
PATCH | /api/media-server-analytics/settings/email | MEDIA_SERVER_ANALYTICS_MANAGE_SETTINGS | updateEmailSettings |
POST | /api/media-server-analytics/settings/email/test | MEDIA_SERVER_ANALYTICS_MANAGE_SETTINGS | testEmail |
GET | /api/media-server-analytics/settings/newsletter-images | MEDIA_SERVER_ANALYTICS_MANAGE_SETTINGS | getNewsletterImageSettings |
PATCH | /api/media-server-analytics/settings/newsletter-images | MEDIA_SERVER_ANALYTICS_MANAGE_SETTINGS | updateNewsletterImageSettings |
GET | /api/media-server-analytics/connections | MEDIA_SERVER_ANALYTICS_VIEW | listConnections |
POST | /api/media-server-analytics/connections | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | createConnection |
GET | /api/media-server-analytics/connections/:id | MEDIA_SERVER_ANALYTICS_VIEW | getConnection |
PATCH | /api/media-server-analytics/connections/:id | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | updateConnection |
DELETE | /api/media-server-analytics/connections/:id | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | deleteConnection |
POST | /api/media-server-analytics/connections/:id/test | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | testConnection |
POST | /api/media-server-analytics/connections/:id/sync | MEDIA_SERVER_ANALYTICS_MANAGE_CONNECTIONS | syncConnection |
GET | /api/media-server-analytics/connections/:id/libraries | MEDIA_SERVER_ANALYTICS_VIEW | libraries |
/media-server-analytics/nl-image
From NewsletterImageController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media-server-analytics/nl-image/:id | — | serve |
/media/cleanup
From CleanupController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media/cleanup/catalog | LIBRARY_CLEANUP_VIEW | catalog |
POST | /api/media/cleanup/playback/rebuild | LIBRARY_CLEANUP_RUN | rebuildPlayback |
POST | /api/media/cleanup/validate | LIBRARY_CLEANUP_VIEW | validate |
GET | /api/media/cleanup/templates | LIBRARY_CLEANUP_VIEW | templates |
GET | /api/media/cleanup/policies | LIBRARY_CLEANUP_VIEW | listPolicies |
POST | /api/media/cleanup/policies | LIBRARY_CLEANUP_POLICY_CREATE | createPolicy |
POST | /api/media/cleanup/policies/from-template | LIBRARY_CLEANUP_POLICY_CREATE | createFromTemplate |
GET | /api/media/cleanup/policies/:id | LIBRARY_CLEANUP_VIEW | getPolicy |
PATCH | /api/media/cleanup/policies/:id | LIBRARY_CLEANUP_POLICY_EDIT | updatePolicy |
PUT | /api/media/cleanup/policies/:id/draft | LIBRARY_CLEANUP_POLICY_EDIT | saveDraft |
POST | /api/media/cleanup/policies/:id/publish | LIBRARY_CLEANUP_POLICY_PUBLISH | publishPolicy |
POST | /api/media/cleanup/policies/:id/enable | LIBRARY_CLEANUP_POLICY_ENABLE | enablePolicy |
POST | /api/media/cleanup/policies/:id/disable | LIBRARY_CLEANUP_POLICY_ENABLE | disablePolicy |
POST | /api/media/cleanup/policies/:id/archive | LIBRARY_CLEANUP_POLICY_DELETE | archivePolicy |
DELETE | /api/media/cleanup/policies/:id | LIBRARY_CLEANUP_POLICY_DELETE | deletePolicy |
POST | /api/media/cleanup/policies/:id/simulate | LIBRARY_CLEANUP_SIMULATE | simulate |
POST | /api/media/cleanup/policies/:id/run | LIBRARY_CLEANUP_RUN | run |
POST | /api/media/cleanup/policies/:id/run-items | LIBRARY_CLEANUP_RUN | runItems |
GET | /api/media/cleanup/runs | LIBRARY_CLEANUP_VIEW | listRuns |
GET | /api/media/cleanup/runs/:runId | LIBRARY_CLEANUP_VIEW | getRun |
POST | /api/media/cleanup/runs/:runId/cancel | LIBRARY_CLEANUP_CANCEL | cancelRun |
GET | /api/media/cleanup/runs/:runId/candidates | LIBRARY_CLEANUP_VIEW | listCandidates |
POST | /api/media/cleanup/runs/:runId/plans | LIBRARY_CLEANUP_RUN | createPlan |
GET | /api/media/cleanup/plans | LIBRARY_CLEANUP_VIEW | listPlans |
GET | /api/media/cleanup/plans/:planId | LIBRARY_CLEANUP_VIEW | getPlan |
GET | /api/media/cleanup/plans/:planId/actions | LIBRARY_CLEANUP_VIEW | listPlanActions |
POST | /api/media/cleanup/plans/:planId/approve | LIBRARY_CLEANUP_APPROVE | approvePlan |
POST | /api/media/cleanup/plans/:planId/reject | LIBRARY_CLEANUP_APPROVE | rejectPlan |
POST | /api/media/cleanup/plans/:planId/cancel | LIBRARY_CLEANUP_CANCEL | cancelPlan |
POST | /api/media/cleanup/plans/:planId/execute | LIBRARY_CLEANUP_TRASH | executePlan |
GET | /api/media/cleanup/quarantine | LIBRARY_CLEANUP_VIEW | listQuarantine |
GET | /api/media/cleanup/quarantine/:id | LIBRARY_CLEANUP_VIEW | getQuarantineItem |
POST | /api/media/cleanup/quarantine/:id/restore | LIBRARY_CLEANUP_RESTORE | restoreQuarantined |
POST | /api/media/cleanup/quarantine/:id/purge | LIBRARY_CLEANUP_PERMANENT_DELETE | purgeQuarantined |
GET | /api/media/cleanup/protections/expiring | LIBRARY_CLEANUP_PROTECTION_VIEW | expiring |
GET | /api/media/cleanup/protections | LIBRARY_CLEANUP_PROTECTION_VIEW | listProtections |
POST | /api/media/cleanup/protections | LIBRARY_CLEANUP_PROTECTION_CREATE | createProtection |
POST | /api/media/cleanup/protections/bulk | LIBRARY_CLEANUP_PROTECTION_CREATE | bulkCreateProtections |
GET | /api/media/cleanup/protections/:id | LIBRARY_CLEANUP_PROTECTION_VIEW | getProtection |
POST | /api/media/cleanup/protections/:id/revoke | LIBRARY_CLEANUP_PROTECTION_REVOKE | revokeProtection |
/media/intake
From MediaIntakeController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media/intake/summary | MEDIA_INTAKE_VIEW | summary |
GET | /api/media/intake/jobs | MEDIA_INTAKE_VIEW | jobs |
GET | /api/media/intake/jobs/:id | MEDIA_INTAKE_VIEW | job |
POST | /api/media/intake/jobs | MEDIA_INTAKE_OPERATE | enqueue |
POST | /api/media/intake/jobs/:id/advance | MEDIA_INTAKE_OPERATE | advance |
POST | /api/media/intake/jobs/:id/retry | MEDIA_INTAKE_OPERATE | retry |
POST | /api/media/intake/jobs/:id/cancel | MEDIA_INTAKE_OPERATE | cancel |
POST | /api/media/intake/jobs/:id/release | MEDIA_INTAKE_OPERATE | release |
GET | /api/media/intake/profiles | MEDIA_INTAKE_VIEW | listProfiles |
POST | /api/media/intake/profiles | MEDIA_INTAKE_MANAGE | createProfile |
GET | /api/media/intake/profiles/:id | MEDIA_INTAKE_VIEW | profile |
PATCH | /api/media/intake/profiles/:id | MEDIA_INTAKE_MANAGE | updateProfile |
DELETE | /api/media/intake/profiles/:id | MEDIA_INTAKE_MANAGE | removeProfile |
POST | /api/media/intake/profiles/:id/probe | MEDIA_INTAKE_MANAGE | probe |
GET | /api/media/intake/path-mappings | MEDIA_INTAKE_VIEW | listMappings |
POST | /api/media/intake/path-mappings | MEDIA_INTAKE_MANAGE | createMapping |
GET | /api/media/intake/path-mappings/resolve | MEDIA_INTAKE_VIEW | resolve |
PATCH | /api/media/intake/path-mappings/:id | MEDIA_INTAKE_MANAGE | updateMapping |
DELETE | /api/media/intake/path-mappings/:id | MEDIA_INTAKE_MANAGE | removeMapping |
GET | /api/media/intake/migration/preview | MEDIA_INTAKE_MIGRATE | previewMigration |
POST | /api/media/intake/migration/apply | MEDIA_INTAKE_MIGRATE | applyMigration |
POST | /api/media/intake/migration/revert | MEDIA_INTAKE_MIGRATE | revertMigration |
/media/trakt
From TraktController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/media/trakt/status | MEDIA_MANAGER_VIEW | status |
POST | /api/media/trakt/device/start | MEDIA_MANAGER_VIEW | startDevice |
POST | /api/media/trakt/device/poll | MEDIA_MANAGER_VIEW | pollDevice |
DELETE | /api/media/trakt/link | MEDIA_MANAGER_VIEW | disconnect |
PATCH | /api/media/trakt/settings | MEDIA_MANAGER_VIEW | updateSettings |
POST | /api/media/trakt/sync/watchlist | MEDIA_ACQUISITION_MANAGE_WATCHLIST | importWatchlist |
POST | /api/media/trakt/sync/collection | MEDIA_MANAGER_VIEW | pushCollection |
POST | /api/media/trakt/sync/watched | MEDIA_MANAGER_VIEW | syncWatched |
POST | /api/media/trakt/sync/ratings | MEDIA_MANAGER_VIEW | syncRatings |
POST | /api/media/trakt/sync/backfill | MEDIA_MANAGER_VIEW | backfill |
/modules
From ModuleRegistryController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/modules/enabled | MODULES_VIEW | enabled |
GET | /api/modules/license | MODULES_VIEW | licenseStatus |
GET | /api/modules | MODULES_VIEW | list |
GET | /api/modules/:id | MODULES_VIEW | get |
GET | /api/modules/:id/manifest | MODULES_VIEW | manifest |
GET | /api/modules/:id/health | MODULES_VIEW | moduleHealth |
POST | /api/modules/:id/enable | MODULES_MANAGE | enable |
POST | /api/modules/:id/disable | MODULES_MANAGE | disable |
/operations
From OperationsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/operations/capabilities | CONSOLE_VIEW | capabilities |
GET | /api/operations/snapshot | CONSOLE_VIEW | snapshot |
/release-scoring
From ReleaseScoringController.
| Method | Path | Permission | Handler |
|---|---|---|---|
POST | /api/release-scoring/score | RELEASE_SCORING_VIEW | score |
POST | /api/release-scoring/test-rule | RELEASE_SCORING_VIEW | testRule |
/subtitle-intelligence
From SubtitleIntelligenceController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/subtitle-intelligence/settings | SUBTITLE_INTELLIGENCE_VIEW | getSettings |
PATCH | /api/subtitle-intelligence/settings | SUBTITLE_INTELLIGENCE_SETTINGS | updateSettings |
GET | /api/subtitle-intelligence/dashboard | SUBTITLE_INTELLIGENCE_VIEW | dashboard |
GET | /api/subtitle-intelligence/providers | SUBTITLE_INTELLIGENCE_VIEW | listProviders |
PATCH | /api/subtitle-intelligence/providers/:provider | SUBTITLE_INTELLIGENCE_PROVIDERS | upsertProvider |
POST | /api/subtitle-intelligence/providers/:provider/test | SUBTITLE_INTELLIGENCE_PROVIDERS | testProvider |
POST | /api/subtitle-intelligence/providers/health-check | SUBTITLE_INTELLIGENCE_PROVIDERS | healthCheckAll |
POST | /api/subtitle-intelligence/libraries/:libraryId/scan-missing | SUBTITLE_INTELLIGENCE_SEARCH | scanMissing |
GET | /api/subtitle-intelligence/libraries/:libraryId/languages | SUBTITLE_INTELLIGENCE_VIEW | getLanguages |
PATCH | /api/subtitle-intelligence/libraries/:libraryId/languages | SUBTITLE_INTELLIGENCE_SETTINGS | setLanguages |
POST | /api/subtitle-intelligence/items/:id/fingerprint | SUBTITLE_INTELLIGENCE_SEARCH | fingerprint |
POST | /api/subtitle-intelligence/items/:id/search | SUBTITLE_INTELLIGENCE_SEARCH | search |
GET | /api/subtitle-intelligence/items/:id/candidates | SUBTITLE_INTELLIGENCE_VIEW | candidates |
POST | /api/subtitle-intelligence/candidates/:candidateId/download | SUBTITLE_INTELLIGENCE_DOWNLOAD | download |
POST | /api/subtitle-intelligence/validate | SUBTITLE_INTELLIGENCE_VIEW | validate |
GET | /api/subtitle-intelligence/sync/capabilities | SUBTITLE_INTELLIGENCE_VIEW | syncCapabilities |
POST | /api/subtitle-intelligence/downloads/:downloadId/synchronize | SUBTITLE_INTELLIGENCE_SYNCHRONIZE | synchronize |
GET | /api/subtitle-intelligence/downloads/:downloadId/synchronizations | SUBTITLE_INTELLIGENCE_VIEW | synchronizations |
GET | /api/subtitle-intelligence/downloads | SUBTITLE_INTELLIGENCE_VIEW | downloads |
GET | /api/subtitle-intelligence/history | SUBTITLE_INTELLIGENCE_VIEW | history |
/torrent-scheduler
From TorrentSchedulerController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/torrent-scheduler/torrents/:engineId/overrides | TORRENT_SCHEDULER_VIEW | listOverrides |
POST | /api/torrent-scheduler/torrents/:engineId/:hash/override | TORRENT_SCHEDULER_OVERRIDE | setOverride |
DELETE | /api/torrent-scheduler/torrents/:engineId/:hash/override/:kind | TORRENT_SCHEDULER_OVERRIDE | clearOverride |
GET | /api/torrent-scheduler/seed-conditions | TORRENT_SCHEDULER_VIEW | seedConditions |
GET | /api/torrent-scheduler/policies | TORRENT_SCHEDULER_VIEW | listPolicies |
POST | /api/torrent-scheduler/policies | TORRENT_SCHEDULER_MANAGE_POLICIES | createPolicy |
PUT | /api/torrent-scheduler/policies/:id | TORRENT_SCHEDULER_MANAGE_POLICIES | updatePolicy |
DELETE | /api/torrent-scheduler/policies/:id | TORRENT_SCHEDULER_MANAGE_POLICIES | deletePolicy |
GET | /api/torrent-scheduler/engines | TORRENT_SCHEDULER_VIEW | engines |
GET | /api/torrent-scheduler/preview | TORRENT_SCHEDULER_VIEW | previewAll |
GET | /api/torrent-scheduler/preview/:engineId | TORRENT_SCHEDULER_VIEW | previewEngine |
GET | /api/torrent-scheduler/history/:engineId | TORRENT_SCHEDULER_VIEW | history |
PUT | /api/torrent-scheduler/engines/:engineId/mode | TORRENT_SCHEDULER_MANAGE_ENGINE_MODE | setMode |
GET | /api/torrent-scheduler/engines/:engineId/activation | TORRENT_SCHEDULER_MANAGE_ENGINE_MODE | describeActivation |
POST | /api/torrent-scheduler/engines/:engineId/activate | TORRENT_SCHEDULER_MANAGE_ENGINE_MODE | activate |
POST | /api/torrent-scheduler/engines/:engineId/deactivate | TORRENT_SCHEDULER_MANAGE_ENGINE_MODE | deactivate |
POST | /api/torrent-scheduler/preview/:engineId/refresh | TORRENT_SCHEDULER_VIEW | refresh |
/torrents
From TorrentsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/torrents/parking | TORRENTS_VIEW | listParked |
GET | /api/torrents/parking/settings | TORRENTS_VIEW | getParkingRules |
PATCH | /api/torrents/parking/settings | TORRENTS_PAUSE | updateParkingRules |
POST | /api/torrents/parking/run | TORRENTS_PAUSE | runParkingSweep |
POST | /api/torrents/parking/:hash/unpark | TORRENTS_RESUME | unpark |
GET | /api/torrents | TORRENTS_VIEW | list |
GET | /api/torrents/:hash | TORRENTS_VIEW | get |
GET | /api/torrents/:hash/matched-rule | TORRENTS_VIEW | matchedRule |
GET | /api/torrents/:hash/files | TORRENTS_VIEW | files |
GET | /api/torrents/:hash/peers | TORRENTS_VIEW | peers |
GET | /api/torrents/:hash/trackers | TORRENTS_VIEW | trackers |
POST | /api/torrents | TORRENTS_ADD | add |
POST | /api/torrents/upload | TORRENTS_ADD | upload |
POST | /api/torrents/bulk | TORRENTS_VIEW | bulk |
POST | /api/torrents/:hash/start | TORRENTS_START | start |
POST | /api/torrents/:hash/stop | TORRENTS_STOP | stop |
POST | /api/torrents/:hash/pause | TORRENTS_PAUSE | pause |
POST | /api/torrents/:hash/resume | TORRENTS_RESUME | resume |
POST | /api/torrents/:hash/recheck | TORRENTS_RECHECK | recheck |
DELETE | /api/torrents/:hash | TORRENTS_DELETE | remove |
POST | /api/torrents/imported-items | TORRENTS_VIEW | importedItems |
DELETE | /api/torrents/:hash/data | TORRENTS_DELETE_DATA | removeData |
POST | /api/torrents/:hash/move | TORRENTS_MOVE | move |
POST | /api/torrents/:hash/limits/upload | TORRENTS_MANAGE_LIMITS | upLimit |
POST | /api/torrents/:hash/limits/download | TORRENTS_MANAGE_LIMITS | downLimit |
POST | /api/torrents/:hash/files/priority | TORRENTS_MANAGE_FILES | filePriority |
POST | /api/torrents/:hash/trackers | TORRENTS_MANAGE_TRACKERS | addTracker |
DELETE | /api/torrents/:hash/trackers | TORRENTS_MANAGE_TRACKERS | removeTracker |
/workflows
From WorkflowsController.
| Method | Path | Permission | Handler |
|---|---|---|---|
GET | /api/workflows/catalog | WORKFLOWS_VIEW | catalog |
POST | /api/workflows/validate | WORKFLOWS_VIEW | validate |
GET | /api/workflows | WORKFLOWS_VIEW | list |
POST | /api/workflows | WORKFLOWS_CREATE | create |
GET | /api/workflows/:id | WORKFLOWS_VIEW | get |
PATCH | /api/workflows/:id | WORKFLOWS_EDIT | update |
PUT | /api/workflows/:id/graph | WORKFLOWS_EDIT | saveDraft |
POST | /api/workflows/:id/publish | WORKFLOWS_PUBLISH | publish |
POST | /api/workflows/:id/simulate | WORKFLOWS_RUN | simulate |
POST | /api/workflows/:id/run | WORKFLOWS_RUN | run |
GET | /api/workflows/:id/executions | WORKFLOWS_VIEW | listExecutions |
GET | /api/workflows/executions/:executionId | WORKFLOWS_VIEW | getExecution |
POST | /api/workflows/executions/:executionId/cancel | WORKFLOWS_RUN | cancelExecution |
GET | /api/workflows/approvals/pending | WORKFLOWS_APPROVE | pendingApprovals |
POST | /api/workflows/approvals/:approvalId/respond | WORKFLOWS_APPROVE | respondApproval |
POST | /api/workflows/:id/enable | WORKFLOWS_PUBLISH | enable |
POST | /api/workflows/:id/disable | WORKFLOWS_PUBLISH | disable |
POST | /api/workflows/:id/archive | WORKFLOWS_DELETE | archive |
DELETE | /api/workflows/:id | WORKFLOWS_DELETE | remove |
See also
- Permissions Reference — what each guard requires
- API Keys — non-interactive access
- WebSocket events — live updates instead of polling