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

    Class LidarrClient

    Lidarr API client for music management

    const lidarr = new LidarrClient({
      baseUrl: 'http://localhost:8686',
      apiKey: 'your-api-key'
    });

    const artists = await lidarr.getArtists();

    Hierarchy

    • ServarrBaseClient
      • LidarrClient
    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 getArtists getArtist addArtist updateArtist deleteArtist getAlbums getAlbum searchArtists getRootFolders addRootFolder deleteRootFolder addAlbum updateAlbum deleteAlbum searchAlbums getCalendar getCalendarFeed getTrackFiles getTrackFile updateTrackFile deleteTrackFile updateTrackFilesEditor deleteTrackFilesBulk getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat updateCustomFormatsBulk deleteCustomFormatsBulk getCustomFormatSchema getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getMetadataProviderConfig getMetadataProviderConfigById updateMetadataProviderConfig getSystemLogs getDiskSpace getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getHistory getHistorySince getArtistHistory markHistoryItemFailed getQueue removeQueueItem removeQueueItemsBulk grabQueueItem grabQueueItemsBulk getQueueDetails getQueueStatus getBlocklist removeBlocklistItem removeBlocklistItemsBulk getWantedMissing getWantedCutoff

    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 artists in the library

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

    • Parameters

      • id: number

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

    • Parameters

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

    • Parameters

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

    • Parameters

      • id: number

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

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

    • Parameters

      • id: number

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

    • Search for artists using MusicBrainz database

      Parameters

      • term: string

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

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

    • Parameters

      • path: string

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

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

    • Parameters

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

    • Parameters

      • id: number

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

    • Parameters

      • term: string

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

    • Parameters

      • Optionalstart: string
      • Optionalend: string
      • Optionalunmonitored: boolean

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

    • Parameters

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

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

    • Get track files by artist, album, or specific file IDs

      Parameters

      • OptionalartistId: number
      • OptionaltrackFileIds: number[]
      • OptionalalbumId: number[]
      • Optionalunmapped: boolean

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

    • Get a specific track file by ID

      Parameters

      • id: number

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

    • Update a track file

      Parameters

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

    • Delete a track file from disk

      Parameters

      • id: number

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

    • Bulk update track files using the editor endpoint

      Parameters

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

    • Bulk delete track files

      Parameters

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

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

    • Parameters

      • id: number

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

    • Parameters

      • id: number

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

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

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

    • Parameters

      • id: number

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

    • Parameters

      • id: number

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

    • Parameters

      • ids: number[]

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

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

    • Get naming configuration settings

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

    • Get naming configuration by ID

      Parameters

      • id: number

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

    • Get media management configuration by ID

      Parameters

      • id: number

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

    • Get metadata provider configuration settings

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

    • Get metadata provider configuration by ID

      Parameters

      • id: number

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

    • Get system logs

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

    • Get disk space information

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

    • Get all import lists

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

    • Get a specific import list by ID

      Parameters

      • id: number

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

    • Update an existing import list

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Lidarr.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: Lidarr.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
      • OptionalartistId: number
      • OptionaldownloadId: string

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

    • Get history since a specific date

      Parameters

      • date: string
      • OptionalartistId: number

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

    • Get history for a specific artist

      Parameters

      • artistId: number
      • OptionaleventType: any

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

      Parameters

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

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

      Parameters

      • id: number

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

    • Force grab 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

      • OptionalartistId: number
      • OptionalincludeUnknownArtistItems: boolean

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

    • Get queue status summary

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

    • Get albums with missing tracks

      Parameters

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

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

    • Get albums below cutoff quality

      Parameters

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getSystemStatusgetHealthgetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsgetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetLogFilesgetLogFileByNamerunCommandgetCommandsgetHostConfiggetHostConfigByIdupdateHostConfiggetUiConfiggetUiConfigByIdupdateUiConfigupdateConfiggetArtistsgetArtistaddArtistupdateArtistdeleteArtistgetAlbumsgetAlbumsearchArtistsgetRootFoldersaddRootFolderdeleteRootFolderaddAlbumupdateAlbumdeleteAlbumsearchAlbumsgetCalendargetCalendarFeedgetTrackFilesgetTrackFileupdateTrackFiledeleteTrackFileupdateTrackFilesEditordeleteTrackFilesBulkgetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatupdateCustomFormatsBulkdeleteCustomFormatsBulkgetCustomFormatSchemagetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetMetadataProviderConfiggetMetadataProviderConfigByIdupdateMetadataProviderConfiggetSystemLogsgetDiskSpacegetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetHistorygetHistorySincegetArtistHistorymarkHistoryItemFailedgetQueueremoveQueueItemremoveQueueItemsBulkgrabQueueItemgrabQueueItemsBulkgetQueueDetailsgetQueueStatusgetBlocklistremoveBlocklistItemremoveBlocklistItemsBulkgetWantedMissinggetWantedCutoff