Tsarr Documentation - v1.8.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();
    Index

    Constructors

    constructor

    Methods

    getSystemStatus getHealth getArtists getArtist addArtist updateArtist deleteArtist getAlbums getAlbum searchArtists runCommand getCommands getRootFolders addRootFolder addAlbum updateAlbum deleteAlbum searchAlbums getCalendar getCalendarFeed getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat updateCustomFormatsBulk deleteCustomFormatsBulk getCustomFormatSchema getHostConfig getHostConfigById updateHostConfig getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getUiConfig getUiConfigById updateUiConfig getMetadataProviderConfig getMetadataProviderConfigById updateMetadataProviderConfig restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getSystemLogs getLogFiles getLogFileByName getDiskSpace getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById 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 updateConfig

    Constructors

    Methods

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

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

    • 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 },
      >

    • Parameters

      • command: any

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

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

      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 },
      >

    • 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 host configuration settings

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

    • Get host configuration by ID

      Parameters

      • id: number

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

    • Update host configuration

      Parameters

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

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

    • Get UI configuration by ID

      Parameters

      • id: number

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

    • Update UI configuration

      Parameters

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

    • Restart the Lidarr application

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

    • Shutdown the Lidarr 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: Lidarr.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 system logs

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

    • Get log files

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

    • Get specific log file by filename

      Parameters

      • filename: string

      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: Lidarr.DiskSpaceResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all tags

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

    • Add a new tag

      Parameters

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

    • Get a specific tag by ID

      Parameters

      • id: number

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

    • Update an existing tag

      Parameters

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

    • Get detailed tag information by ID

      Parameters

      • id: number

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

    • Get all download clients

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

    • Get a specific download client by ID

      Parameters

      • id: number

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

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

    • Get a specific indexer by ID

      Parameters

      • id: number

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

    • Add a new indexer

      Parameters

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

    • Update an existing indexer

      Parameters

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

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

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

    • Get a specific notification provider by ID

      Parameters

      • id: number

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

    • Update an existing notification provider

      Parameters

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

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

    • Parameters

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    getSystemStatusgetHealthgetArtistsgetArtistaddArtistupdateArtistdeleteArtistgetAlbumsgetAlbumsearchArtistsrunCommandgetCommandsgetRootFoldersaddRootFolderaddAlbumupdateAlbumdeleteAlbumsearchAlbumsgetCalendargetCalendarFeedgetQualityProfilesgetQualityProfileaddQualityProfileupdateQualityProfiledeleteQualityProfilegetQualityProfileSchemagetCustomFormatsgetCustomFormataddCustomFormatupdateCustomFormatdeleteCustomFormatupdateCustomFormatsBulkdeleteCustomFormatsBulkgetCustomFormatSchemagetHostConfiggetHostConfigByIdupdateHostConfiggetNamingConfiggetNamingConfigByIdupdateNamingConfiggetNamingConfigExamplesgetMediaManagementConfiggetMediaManagementConfigByIdupdateMediaManagementConfiggetUiConfiggetUiConfigByIdupdateUiConfiggetMetadataProviderConfiggetMetadataProviderConfigByIdupdateMetadataProviderConfigrestartSystemshutdownSystemgetSystemBackupsdeleteSystemBackuprestoreSystemBackupuploadSystemBackupgetSystemLogsgetLogFilesgetLogFileByNamegetDiskSpacegetTagsaddTaggetTagupdateTagdeleteTaggetTagDetailsgetTagDetailByIdgetDownloadClientsgetDownloadClientaddDownloadClientupdateDownloadClientdeleteDownloadClientupdateDownloadClientsBulkdeleteDownloadClientsBulkgetDownloadClientSchematestDownloadClienttestAllDownloadClientsgetIndexersgetIndexeraddIndexerupdateIndexerdeleteIndexergetIndexerSchematestIndexertestAllIndexersgetImportListsgetImportListaddImportListupdateImportListdeleteImportListgetImportListSchematestImportListtestAllImportListsgetNotificationsgetNotificationaddNotificationupdateNotificationdeleteNotificationgetNotificationSchematestNotificationtestAllNotificationsupdateConfig