Tsarr Documentation - v2.11.0
    Preparing search index...

    Class RadarrClient

    Hierarchy

    • ServarrBaseClient
      • RadarrClient
    Index

    Constructors

    constructor

    Methods

    getSystemStatus getHealth getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient getDownloadClientSchema testDownloadClient testAllDownloadClients getIndexers getIndexer addIndexer updateIndexer deleteIndexer getIndexerSchema testIndexer testAllIndexers restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getLogFiles getLogFileByName runCommand getCommands getHostConfig getHostConfigById updateHostConfig getUiConfig getUiConfigById updateUiConfig updateConfig getMovies getMovie addMovie updateMovie deleteMovie searchMovies lookupMovieByTmdbId lookupMovieByImdbId lookupMovieById getRootFolders addRootFolder deleteRootFolder getFilesystem getMediaFiles importMovies getManualImport reprocessManualImport applyManualImport getMovieFiles getMovieFile updateMovieFile deleteMovieFile updateMovieFilesEditor deleteMovieFilesBulk updateMovieFilesBulk getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat updateCustomFormatsBulk deleteCustomFormatsBulk getCustomFormatSchema updateDownloadClientsBulk deleteDownloadClientsBulk getCalendar getCalendarFeed getQueue removeQueueItem removeQueueItemsBulk grabQueueItem grabQueueItemsBulk getQueueDetails getQueueStatus getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getHistory getHistorySince getMovieHistory markHistoryItemFailed getBlocklist removeBlocklistItem removeBlocklistItemsBulk getWantedMissing getWantedCutoff getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getSystemLogs getDiskSpace

    Constructors

    Methods

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • tag: { id?: number; label?: string | null }

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • tag: { id?: number; label?: string | null }

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • notification: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • notification: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • notification: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • client: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • client: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • client: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: string | number
      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • indexer: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • filename: string

      Returns Promise<any>

    • Parameters

      • command: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • config: Record<string, unknown>

      Returns Promise<any>

    • Returns Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

    • Parameters

      • id: string | number
      • config: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      Returns {
          baseUrl: string;
          apiKey: string;
          timeout?: number;
          retry?: RetryOptions;
          headers?: Record<string, string>;
      }

      • baseUrl: string
      • apiKey: string
      • Optionaltimeout?: number

        Request timeout in milliseconds (default: 30000)

      • Optionalretry?: RetryOptions

        Retry configuration for transient failures

      • Optionalheaders?: Record<string, string>

    • Get all movies in the library

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific movie by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Add a new movie to the library

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number
      • Optionaloptions: { deleteFiles?: boolean; addImportExclusion?: boolean }

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Search for movies using TMDB database

      Parameters

      • term: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Search for a movie by TMDB ID

      Parameters

      • tmdbId: number

        The TMDB ID of the movie (e.g., 4247)

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

      Movie details from TMDB

    • Search for a movie by IMDB ID

      Parameters

      • imdbId: string

        The IMDB ID of the movie (e.g., 'tt0175142')

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

      Movie details from IMDB

    • Search for a movie by external ID (TMDB or IMDB)

      Parameters

      • id: string

        Format: 'tmdb:123' or 'imdb:tt0175142'

      Returns Promise<
          | { data: undefined; error: unknown } & {
              request?: Request;
              response?: Response;
          }
          | { data: MovieResource; error: undefined } & {
              request?: Request;
              response?: Response;
          },
      >

      Movie details from the specified provider

      Error if the ID format is invalid or values don't meet requirements

      // Lookup by TMDB ID
      const movie = await radarr.lookupMovieById('tmdb:4247');

      // Lookup by IMDB ID
      const movie = await radarr.lookupMovieById('imdb:tt0175142');

    • Get all configured root folders

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.RootFolderResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • path: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.RootFolderResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • Optionalpath: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • path: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Import physical movie files into the library

      Parameters

      • movies: any[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get manual import candidates for a folder or download

      Parameters

      • options: {
            folder?: string;
            downloadId?: string;
            movieId?: number;
            filterExistingFiles?: boolean;
        } = {}

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ManualImportResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Reprocess manual import candidates to refresh quality/match metadata. Does NOT perform the actual import — use applyManualImport for that.

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Execute a manual import via the command queue. Returns the command resource.

      Parameters

      • files: ManualImportFilePayload[]
      • importMode: "auto" | "copy" | "move" = 'auto'

      Returns Promise<any>

    • Get movie files by movie ID or specific file IDs

      Parameters

      • OptionalmovieId: number[]
      • OptionalmovieFileIds: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieFileResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific movie file by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieFileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Update a movie file

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieFileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a movie file from disk

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk update movie files using the editor endpoint

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk delete movie files

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk update movie files

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all quality profiles

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific quality profile by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a quality profile

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get quality profile schema for creating new profiles

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all custom formats

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CustomFormatResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific custom format by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CustomFormatResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete a custom format

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk delete custom formats

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get custom format schema for creating new formats

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk delete download clients

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get upcoming movie releases in calendar format

      Parameters

      • OptionalstartDate: string
      • OptionalendDate: string
      • Optionalunmonitored: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get calendar feed in iCal format

      Parameters

      • OptionalpastDays: number
      • OptionalfutureDays: number
      • Optionaltags: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get download queue with optional filtering

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalincludeUnknownMovieItems: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Remove an item from the download queue

      Parameters

      • id: number
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk remove items from the download queue

      Parameters

      • ids: number[]
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Force grab/download a queue item

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Force grab/download multiple queue items

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get detailed queue information

      Parameters

      • OptionalmovieId: number
      • OptionalincludeMovie: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get queue status summary

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueStatusResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get a specific import list by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Update an existing import list

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Delete an import list

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get import list schema for available list types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Test an import list configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Test all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get activity history

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalmovieId: number
      • OptionaldownloadId: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get history since a specific date

      Parameters

      • date: string
      • OptionalmovieId: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get history for a specific movie

      Parameters

      • movieId: number
      • OptionaleventType: any

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Mark a failed download as failed in history

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get blocked releases

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.BlocklistResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Remove a release from the blocklist

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Bulk remove releases from the blocklist

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • Optionalpage: number
      • OptionalpageSize: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Parameters

      • Optionalpage: number
      • OptionalpageSize: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NamingConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NamingConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get naming configuration examples

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get media management configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.MediaManagementConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get media management configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.MediaManagementConfigResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get system logs

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.LogResourcePagingResource; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    • Get disk space information

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.DiskSpaceResource[]; error: undefined }
          ) & { request?: Request; response?: Response },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getSystemStatusgetHealthgetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsgetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetLogFilesgetLogFileByNamerunCommandgetCommandsgetHostConfiggetHostConfigByIdupdateHostConfiggetUiConfiggetUiConfigByIdupdateUiConfigupdateConfiggetMoviesgetMovieaddMovieupdateMoviedeleteMoviesearchMovieslookupMovieByTmdbIdlookupMovieByImdbIdlookupMovieByIdgetRootFoldersaddRootFolderdeleteRootFoldergetFilesystemgetMediaFilesimportMoviesgetManualImportreprocessManualImportapplyManualImportgetMovieFilesgetMovieFileupdateMovieFiledeleteMovieFileupdateMovieFilesEditordeleteMovieFilesBulkupdateMovieFilesBulkgetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatupdateCustomFormatsBulkdeleteCustomFormatsBulkgetCustomFormatSchemaupdateDownloadClientsBulkdeleteDownloadClientsBulkgetCalendargetCalendarFeedgetQueueremoveQueueItemremoveQueueItemsBulkgrabQueueItemgrabQueueItemsBulkgetQueueDetailsgetQueueStatusgetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetHistorygetHistorySincegetMovieHistorymarkHistoryItemFailedgetBlocklistremoveBlocklistItemremoveBlocklistItemsBulkgetWantedMissinggetWantedCutoffgetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetSystemLogsgetDiskSpace