Class ProwlarrClient

Prowlarr API client for indexer management

Example

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

const indexers = await prowlarr.getIndexers();

Hierarchy

ServarrBaseClient
- ProwlarrClient

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 getIndexerStats search getApplications getApplication addApplication updateApplication deleteApplication testApplication testAllApplications getApplicationSchema getDevelopmentConfig getDevelopmentConfigById updateDevelopmentConfig getSystemLogs

Constructors

constructor

new ProwlarrClient(config: ServarrClientConfig): ProwlarrClient
Parameters
- config: ServarrClientConfig
Returns ProwlarrClient
Overrides ServarrBaseClient.constructor
- Defined in clients/prowlarr.ts:93

Methods

getSystemStatus

getSystemStatus(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getSystemStatus
- Defined in clients/base.ts:105

getHealth

getHealth(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getHealth
- Defined in clients/base.ts:109

getTags

getTags(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getTags
- Defined in clients/base.ts:115

addTag

addTag(tag: { id?: number; label?: string | null }): Promise<any>
Parameters
- tag: { id?: number; label?: string | null }
Returns Promise<any>
Inherited from ServarrBaseClient.addTag
- Defined in clients/base.ts:119

getTag

getTag(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getTag
- Defined in clients/base.ts:123

updateTag

updateTag(
id: string | number,
tag: { id?: number; label?: string | null },
): Promise<any>
Parameters
- id: string | number
- tag: { id?: number; label?: string | null }
Returns Promise<any>
Inherited from ServarrBaseClient.updateTag
- Defined in clients/base.ts:127

deleteTag

deleteTag(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.deleteTag
- Defined in clients/base.ts:131

getTagDetails

getTagDetails(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getTagDetails
- Defined in clients/base.ts:135

getTagDetailById

getTagDetailById(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getTagDetailById
- Defined in clients/base.ts:139

getNotifications

getNotifications(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getNotifications
- Defined in clients/base.ts:145

getNotification

getNotification(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getNotification
- Defined in clients/base.ts:149

addNotification

addNotification(notification: Record<string, unknown>): Promise<any>
Parameters
- notification: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.addNotification
- Defined in clients/base.ts:153

updateNotification

updateNotification(
id: string | number,
notification: Record<string, unknown>,
): Promise<any>
Parameters
- id: string | number
- notification: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.updateNotification
- Defined in clients/base.ts:157

deleteNotification

deleteNotification(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.deleteNotification
- Defined in clients/base.ts:161

getNotificationSchema

getNotificationSchema(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getNotificationSchema
- Defined in clients/base.ts:165

testNotification

testNotification(notification: Record<string, unknown>): Promise<any>
Parameters
- notification: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.testNotification
- Defined in clients/base.ts:169

testAllNotifications

testAllNotifications(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.testAllNotifications
- Defined in clients/base.ts:173

getDownloadClients

getDownloadClients(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getDownloadClients
- Defined in clients/base.ts:179

getDownloadClient

getDownloadClient(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getDownloadClient
- Defined in clients/base.ts:183

addDownloadClient

addDownloadClient(client: Record<string, unknown>): Promise<any>
Parameters
- client: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.addDownloadClient
- Defined in clients/base.ts:187

updateDownloadClient

updateDownloadClient(
id: string | number,
client: Record<string, unknown>,
): Promise<any>
Parameters
- id: string | number
- client: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.updateDownloadClient
- Defined in clients/base.ts:191

deleteDownloadClient

deleteDownloadClient(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.deleteDownloadClient
- Defined in clients/base.ts:195

getDownloadClientSchema

getDownloadClientSchema(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getDownloadClientSchema
- Defined in clients/base.ts:199

testDownloadClient

testDownloadClient(client: Record<string, unknown>): Promise<any>
Parameters
- client: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.testDownloadClient
- Defined in clients/base.ts:203

testAllDownloadClients

testAllDownloadClients(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.testAllDownloadClients
- Defined in clients/base.ts:207

getIndexers

getIndexers(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getIndexers
- Defined in clients/base.ts:213

getIndexer

getIndexer(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getIndexer
- Defined in clients/base.ts:217

addIndexer

addIndexer(indexer: Record<string, unknown>): Promise<any>
Parameters
- indexer: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.addIndexer
- Defined in clients/base.ts:221

updateIndexer

updateIndexer(
id: string | number,
indexer: Record<string, unknown>,
): Promise<any>
Parameters
- id: string | number
- indexer: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.updateIndexer
- Defined in clients/base.ts:225

deleteIndexer

deleteIndexer(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.deleteIndexer
- Defined in clients/base.ts:229

getIndexerSchema

getIndexerSchema(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getIndexerSchema
- Defined in clients/base.ts:233

testIndexer

testIndexer(indexer: Record<string, unknown>): Promise<any>
Parameters
- indexer: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.testIndexer
- Defined in clients/base.ts:237

testAllIndexers

testAllIndexers(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.testAllIndexers
- Defined in clients/base.ts:241

restartSystem

restartSystem(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.restartSystem
- Defined in clients/base.ts:247

shutdownSystem

shutdownSystem(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.shutdownSystem
- Defined in clients/base.ts:251

getSystemBackups

getSystemBackups(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getSystemBackups
- Defined in clients/base.ts:255

deleteSystemBackup

deleteSystemBackup(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.deleteSystemBackup
- Defined in clients/base.ts:259

restoreSystemBackup

restoreSystemBackup(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.restoreSystemBackup
- Defined in clients/base.ts:263

uploadSystemBackup

uploadSystemBackup(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.uploadSystemBackup
- Defined in clients/base.ts:267

getLogFiles

getLogFiles(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getLogFiles
- Defined in clients/base.ts:271

getLogFileByName

getLogFileByName(filename: string): Promise<any>
Parameters
- filename: string
Returns Promise<any>
Inherited from ServarrBaseClient.getLogFileByName
- Defined in clients/base.ts:275

runCommand

runCommand(command: Record<string, unknown>): Promise<any>
Parameters
- command: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.runCommand
- Defined in clients/base.ts:281

getCommands

getCommands(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getCommands
- Defined in clients/base.ts:285

getHostConfig

getHostConfig(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getHostConfig
- Defined in clients/base.ts:291

getHostConfigById

getHostConfigById(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getHostConfigById
- Defined in clients/base.ts:295

updateHostConfig

updateHostConfig(
id: string | number,
config: Record<string, unknown>,
): Promise<any>
Parameters
- id: string | number
- config: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.updateHostConfig
- Defined in clients/base.ts:299

getUiConfig

getUiConfig(): Promise<any>
Returns Promise<any>
Inherited from ServarrBaseClient.getUiConfig
- Defined in clients/base.ts:305

getUiConfigById

getUiConfigById(id: number): Promise<any>
Parameters
- id: number
Returns Promise<any>
Inherited from ServarrBaseClient.getUiConfigById
- Defined in clients/base.ts:309

updateUiConfig

updateUiConfig(
id: string | number,
config: Record<string, unknown>,
): Promise<any>
Parameters
- id: string | number
- config: Record<string, unknown>
Returns Promise<any>
Inherited from ServarrBaseClient.updateUiConfig
- Defined in clients/base.ts:313

updateConfig

updateConfig(
    newConfig: Partial<ServarrClientConfig>,
): {
    baseUrl: string;
    apiKey: string;
    timeout?: number;
    retry?: RetryOptions;
    headers?: Record<string, string>;
}
Parameters
- newConfig: Partial<ServarrClientConfig>
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>
Inherited from ServarrBaseClient.updateConfig
- Defined in clients/base.ts:318

getIndexerStats

getIndexerStats(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: IndexerStatsResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
Get indexer statistics

Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: IndexerStatsResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:104

search

search(
    query: string,
    indexerIds?: number[],
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.ReleaseResource[]; 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 },
>
- Defined in clients/prowlarr.ts:113

getApplications

getApplications(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource[]; error: undefined }
    ) & { request?: Request; response?: Response },
>
Get all applications

Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource[]; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:127

getApplication

getApplication(
    id: number,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource; 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 },
>
- Defined in clients/prowlarr.ts:134

addApplication

addApplication(
    application: ApplicationResource,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
Add a new application
Parameters
- application: ApplicationResource
Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:141

updateApplication

updateApplication(
    id: number,
    application: ApplicationResource,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
Update an existing application
Parameters
- id: number
- application: ApplicationResource
Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:148

deleteApplication

deleteApplication(
    id: number,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; 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 },
>
- Defined in clients/prowlarr.ts:155

testApplication

testApplication(
    application: ApplicationResource,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request?: Request; response?: Response },
>
Test an application configuration
Parameters
- application: ApplicationResource
Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: unknown; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:162

testAllApplications

testAllApplications(): 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 },
>
- Defined in clients/prowlarr.ts:169

getApplicationSchema

getApplicationSchema(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: ApplicationResource[]; 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 },
>
- Defined in clients/prowlarr.ts:176

getDevelopmentConfig

getDevelopmentConfig(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.DevelopmentConfigResource; 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 },
>
- Defined in clients/prowlarr.ts:185

getDevelopmentConfigById

getDevelopmentConfigById(
    id: number,
): 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 },
>
- Defined in clients/prowlarr.ts:192

updateDevelopmentConfig

updateDevelopmentConfig(
    id: number,
    config: Prowlarr.DevelopmentConfigResource,
): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.DevelopmentConfigResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
Update development configuration
Parameters
- id: number
- config: Prowlarr.DevelopmentConfigResource
Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.DevelopmentConfigResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:199

getSystemLogs

getSystemLogs(): Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.LogResourcePagingResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
Get system logs

Returns Promise<
    (
        | { data: undefined; error: unknown }
        | { data: Prowlarr.LogResourcePagingResource; error: undefined }
    ) & { request?: Request; response?: Response },
>
- Defined in clients/prowlarr.ts:208

Class ProwlarrClient

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProwlarrClient

Methods

getSystemStatus

Returns Promise<any>

getHealth

Returns Promise<any>

getTags

Returns Promise<any>

addTag

Parameters

Returns Promise<any>

getTag

Parameters

Returns Promise<any>

updateTag

Parameters

Returns Promise<any>

deleteTag

Parameters

Returns Promise<any>

getTagDetails

Returns Promise<any>

getTagDetailById

Parameters

Returns Promise<any>

getNotifications

Returns Promise<any>

getNotification

Parameters

Returns Promise<any>

addNotification

Parameters

Returns Promise<any>

updateNotification

Parameters

Returns Promise<any>

deleteNotification

Parameters

Returns Promise<any>

getNotificationSchema

Returns Promise<any>

testNotification

Parameters

Returns Promise<any>

testAllNotifications

Returns Promise<any>

getDownloadClients

Returns Promise<any>

getDownloadClient

Parameters

Returns Promise<any>

addDownloadClient

Parameters

Returns Promise<any>

updateDownloadClient

Parameters

Returns Promise<any>

deleteDownloadClient

Parameters

Returns Promise<any>

getDownloadClientSchema

Returns Promise<any>

testDownloadClient

Parameters

Returns Promise<any>

testAllDownloadClients

Returns Promise<any>

getIndexers

Returns Promise<any>

getIndexer

Parameters

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

`Optional`timeout?: number

`Optional`retry?: RetryOptions

`Optional`headers?: Record<string, string>

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

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