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

    Class ProwlarrClient

    Prowlarr API client for indexer management

    const prowlarr = new ProwlarrClient({
      baseUrl: 'http://localhost:9696',
      apiKey: 'your-api-key'
    });

    const indexers = await prowlarr.getIndexers();
    Index

    Constructors

    constructor

    Methods

    getSystemStatus getHealth getIndexers getIndexer addIndexer updateIndexer deleteIndexer getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient testDownloadClient testAllDownloadClients getDownloadClientSchema search getApplications runCommand getCommands getHostConfig getHostConfigById updateHostConfig getUiConfig getUiConfigById updateUiConfig getDevelopmentConfig getDevelopmentConfigById updateDevelopmentConfig restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getSystemLogs getLogFiles getLogFileByName getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById getApplication addApplication updateApplication deleteApplication testApplication testAllApplications getApplicationSchema getIndexerSchema testIndexer testAllIndexers getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications updateConfig

    Constructors

    Methods

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

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

    • Get all configured indexers

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

    • Parameters

      • id: number

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

    • Parameters

      • id: number

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

    • Get all configured download clients

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

    • Get a specific download client by ID

      Parameters

      • id: number

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

    • 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 download client schema for available download client types

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

    • Search across all or specific indexers

      Parameters

      • query: string
      • OptionalindexerIds: number[]

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

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

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

    • Get host configuration settings

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

    • Get host configuration by ID

      Parameters

      • id: number

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

    • Get UI configuration settings

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

    • Get UI configuration by ID

      Parameters

      • id: number

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

    • Get development configuration settings

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

    • Get development configuration by ID

      Parameters

      • id: number

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

    • Restart the Prowlarr application

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

    • Shutdown the Prowlarr 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: Prowlarr.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: Prowlarr.LogResourcePagingResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get log files

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

    • Get specific log file by filename

      Parameters

      • filename: string

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

    • Get all tags

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

    • Add a new tag

      Parameters

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

    • Get a specific tag by ID

      Parameters

      • id: number

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

    • Update an existing tag

      Parameters

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

    • Get detailed tag information by ID

      Parameters

      • id: number

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

    • Get a specific application by ID

      Parameters

      • id: number

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

    • Add a new application

      Parameters

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

    • Update an existing application

      Parameters

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

    • Delete an application

      Parameters

      • id: number

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

    • Test an application configuration

      Parameters

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

    • Test all applications

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

    • Get application schema for available application types

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

    • Get indexer schema for available indexer types

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

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

    • Get a specific notification provider by ID

      Parameters

      • id: number

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