Tsarr Documentation - v1.8.0
    Preparing search index...

    Class SonarrClient

    Sonarr API client for TV show management

    const sonarr = new SonarrClient({
      baseUrl: 'http://localhost:8989',
      apiKey: 'your-api-key'
    });

    const series = await sonarr.getSeries();
    Index

    Constructors

    constructor

    Methods

    getApi getSystemStatus getHealth getSeries getSeriesById addSeries updateSeries deleteSeries getSeriesFolder searchSeries getRootFolders addRootFolder deleteRootFolder getLogs getUpdates getUpdateSettings getUpdateSetting getHostConfig getHostConfigById updateHostConfig getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getUiConfig getUiConfigById updateUiConfig restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getDiskSpace getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById getEpisodes getEpisode updateEpisode getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat updateCustomFormatsBulk deleteCustomFormatsBulk getCustomFormatSchema getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient updateDownloadClientsBulk deleteDownloadClientsBulk getDownloadClientSchema testDownloadClient testAllDownloadClients getIndexers getIndexer addIndexer updateIndexer deleteIndexer getIndexerSchema testIndexer testAllIndexers getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications runCommand getCommands getCommand updateConfig

    Constructors

    Methods

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

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

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

    • Get all TV series in the library

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

    • Get a specific series by ID

      Parameters

      • id: number

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

    • Add a new series to the library

      Parameters

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

    • Update an existing series

      Parameters

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

    • Delete a series

      Parameters

      • id: number

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

    • Get series folder information

      Parameters

      • id: number

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

    • Search for TV series using TVDB database

      Parameters

      • term: string

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

    • Get all configured root folders

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

    • Add a new root folder

      Parameters

      • path: string

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

    • Delete a root folder by ID

      Parameters

      • id: number

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

    • Get system logs with optional filtering

      Parameters

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

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

    • Get available updates

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

    • Get update settings

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

    • Get a specific update setting

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

    • Get host configuration settings

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

    • Get host configuration by ID

      Parameters

      • id: number

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

    • Update host configuration

      Parameters

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

    • Get naming configuration settings

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

    • Get naming configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Sonarr.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: Sonarr.MediaManagementConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get media management configuration by ID

      Parameters

      • id: number

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

    • Get UI configuration settings

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

    • Get UI configuration by ID

      Parameters

      • id: number

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

    • Update UI configuration

      Parameters

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

    • Restart the Sonarr application

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

    • Shutdown the Sonarr application

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

    • Get system backup files

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

    • Delete a system backup by ID

      Parameters

      • id: number

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

    • Restore system backup by ID

      Parameters

      • id: number

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

    • Upload and restore system backup

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

    • Get disk space information

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

    • Get all tags

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

    • Add a new tag

      Parameters

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

    • Get a specific tag by ID

      Parameters

      • id: number

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

    • Update an existing tag

      Parameters

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

    • Delete a tag

      Parameters

      • id: number

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

    • Get detailed tag information

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

    • Get detailed tag information by ID

      Parameters

      • id: number

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

    • Get all episodes

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

    • Get a specific episode by ID

      Parameters

      • id: number

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

    • Update an episode

      Parameters

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

    • Get all quality profiles

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

    • Get a specific quality profile by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Sonarr.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

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

    • Get all custom formats

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

    • Get a specific custom format by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Sonarr.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

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

    • Get all download clients

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

    • Get a specific download client by ID

      Parameters

      • id: number

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

    • Delete a download client

      Parameters

      • id: number

      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 download client schema

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

    • Test a download client configuration

      Parameters

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

    • Test all download clients

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

    • Get all indexers

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

    • Get a specific indexer by ID

      Parameters

      • id: number

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

    • Add a new indexer

      Parameters

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

    • Update an existing indexer

      Parameters

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

    • Delete an indexer

      Parameters

      • id: number

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

    • Get indexer schema

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

    • Test an indexer configuration

      Parameters

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

    • Test all indexers

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

    • Get all import lists

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

    • Get a specific import list by ID

      Parameters

      • id: number

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

    • Update an existing import list

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Sonarr.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

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Sonarr.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 all notification providers

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

    • Get a specific notification provider by ID

      Parameters

      • id: number

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

    • Update an existing notification provider

      Parameters

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

    • Delete a notification provider

      Parameters

      • id: number

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

    • Get notification schema

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

    • Test a notification configuration

      Parameters

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

    • Test all notifications

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

    • Execute a Sonarr command

      Parameters

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

    • Get all commands

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

    • Get command by ID

      Parameters

      • id: number

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

    • Parameters

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getApigetSystemStatusgetHealthgetSeriesgetSeriesByIdaddSeriesupdateSeriesdeleteSeriesgetSeriesFoldersearchSeriesgetRootFoldersaddRootFolderdeleteRootFoldergetLogsgetUpdatesgetUpdateSettingsgetUpdateSettinggetHostConfiggetHostConfigByIdupdateHostConfiggetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetUiConfiggetUiConfigByIdupdateUiConfigrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetDiskSpacegetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdgetEpisodesgetEpisodeupdateEpisodegetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatupdateCustomFormatsBulkdeleteCustomFormatsBulkgetCustomFormatSchemagetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientupdateDownloadClientsBulkdeleteDownloadClientsBulkgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersgetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsrunCommandgetCommandsgetCommandupdateConfig