Prowlarr

https://prowlarr.com/docs
Admin
Prowlarr is an indexer manager and proxy for your PVR applications, designed to manage and integrate...
Tokens:5,298
Snippets:51
Trust Score:8.4
Update:9 months ago
Show doc for...
Tokens:
Raw
### Start and enable Prowlarr service (Linux systemd)

Source: https://prowlarr.com/docs/index

These commands manage the Prowlarr service using `systemd` on Linux. They reload the daemon to recognize the service file and then enable and start the Prowlarr service. This ensures Prowlarr starts automatically on boot.

```bash
sudo systemctl daemon-reload
sudo systemctl enable --now prowlarr
```

--------------------------------

### Install Prowlarr using yay (Arch Linux)

Source: https://prowlarr.com/docs/index

This command utilizes the `yay` AUR helper to install the prowlarr package and its dependencies on Arch Linux. Ensure you have `yay` installed and configured.

```bash
yay -S prowlarr-bin
```

--------------------------------

### Self-sign Prowlarr application on macOS

Source: https://prowlarr.com/docs/index

This command is used on macOS to self-sign the Prowlarr application and remove quarantine attributes. This is often required after downloading and extracting applications from the internet to allow them to run. It uses `codesign` to sign the app and `xattr` to remove quarantine flags.

```bash
codesign --force --deep -s - /Applications/Prowlarr.app && xattr -rd com.apple.quarantine /Applications/Prowlarr.app
```

--------------------------------

### UI Configuration API

Source: https://prowlarr.com/docs/api

Endpoints for managing user interface configurations.

```APIDOC
## UI Configuration API

### Description
Configure settings related to the Prowlarr user interface.

### Endpoints

- **PUT /api/v1/config/ui/{id}**: Update a UI configuration item.
- **GET /api/v1/config/ui/{id}**: Get a specific UI configuration item.
- **GET /api/v1/config/ui**: Get all UI configuration items.
```

--------------------------------

### Backup and Restore API

Source: https://prowlarr.com/docs/api

Endpoints for managing backups, including creating, restoring, and deleting backup files.

```APIDOC
## Backup and Restore API

### Description
Manage system backups, including creating, restoring from, and deleting backup files.

### Endpoints

- **GET /api/v1/system/backup**: Get a list of available backups.
- **DELETE /api/v1/system/backup/{id}**: Delete a specific backup by ID.
- **POST /api/v1/system/backup/restore/{id}**: Restore the system from a specific backup.
- **POST /api/v1/system/backup/restore/upload**: Upload a backup file for restoration.
```

--------------------------------

### Download Client Configuration API

Source: https://prowlarr.com/docs/api

Endpoints for retrieving and updating download client configurations.

```APIDOC
## Download Client Configuration API

### Description
Manage configurations related to download clients.

### Endpoints

- **GET /api/v1/config/downloadclient/{id}**: Get the configuration for a specific download client.
- **PUT /api/v1/config/downloadclient/{id}**: Update the configuration for a specific download client.
- **GET /api/v1/config/downloadclient**: Get all download client configurations.
```

--------------------------------

### Host Configuration API

Source: https://prowlarr.com/docs/api

Endpoints for managing host-related configurations.

```APIDOC
## Host Configuration API

### Description
Manage configurations related to the host system.

### Endpoints

- **GET /api/v1/config/host/{id}**: Get the configuration for a specific host.
- **PUT /api/v1/config/host/{id}**: Update the configuration for a specific host.
- **GET /api/v1/config/host**: Get all host configurations.
```

--------------------------------

### File System API

Source: https://prowlarr.com/docs/api

Endpoints for interacting with the file system, including listing directories and file types.

```APIDOC
## File System API

### Description
Access and query information about the file system.

### Endpoints

- **GET /api/v1/filesystem**: Get a listing of the file system.
- **GET /api/v1/filesystem/type**: Get information about file system types.
```

--------------------------------

### Command API

Source: https://prowlarr.com/docs/api

Endpoints for managing and querying system commands.

```APIDOC
## Command API

### Description
Provides functionality for executing and managing system commands.

### Endpoints

- **GET /api/v1/command/{id}**: Get the status of a specific command.
- **DELETE /api/v1/command/{id}**: Cancel a running command.
- **POST /api/v1/command**: Execute a new command.
- **GET /api/v1/command**: Get a list of executed commands.
```

--------------------------------

### Development Configuration API

Source: https://prowlarr.com/docs/api

Endpoints for managing development-related configurations.

```APIDOC
## Development Configuration API

### Description
Configure development-specific settings for Prowlarr.

### Endpoints

- **PUT /api/v1/config/development/{id}**: Update a development configuration item.
- **GET /api/v1/config/development/{id}**: Get a specific development configuration item.
- **GET /api/v1/config/development**: Get all development configuration items.
```

--------------------------------

### Static Resource API

Source: https://prowlarr.com/docs/api

Endpoints for serving static resources, including the login page and other static content.

```APIDOC
## Static Resource API

### Description
Provides access to static resources served by Prowlarr.

### Endpoints

- **GET /login**: Access the login page.
- **GET /content/{path}**: Retrieve content from the `/content` directory.
- **GET /**: Access the root of the static resource server.
- **GET /{path}**: Access a file at the specified path.
```

--------------------------------

### Newznab and Download Integration API

Source: https://prowlarr.com/docs/api

Endpoints related to Newznab indexer specific features and download handling.

```APIDOC
## Newznab and Download Integration API

### Description
Provides endpoints for interacting with Newznab indexers and handling downloads.

### Endpoints

- **GET /api/v1/indexer/{id}/newznab**: Get Newznab specific details for an indexer.
- **GET /{id}/api**: Access the API endpoint for a specific application/indexer.
- **GET /api/v1/indexer/{id}/download**: Initiate a download for a specific indexer.
- **GET /{id}/download**: Initiate a download for a specific application/indexer.
```

--------------------------------

### Download Client API

Source: https://prowlarr.com/docs/api

Endpoints for managing download clients, including testing, bulk operations, and schema retrieval.

```APIDOC
## Download Client API

### Description
Manage download clients integrated with Prowlarr, including adding, updating, deleting, testing, and performing bulk operations.

### Endpoints

- **GET /api/v1/downloadclient/{id}**: Get a specific download client by ID.
- **PUT /api/v1/downloadclient/{id}**: Update a specific download client.
- **DELETE /api/v1/downloadclient/{id}**: Delete a specific download client.
- **GET /api/v1/downloadclient**: Get a list of all download clients.
- **POST /api/v1/downloadclient**: Add a new download client.
- **PUT /api/v1/downloadclient/bulk**: Perform bulk update operations on download clients.
- **DELETE /api/v1/downloadclient/bulk**: Perform bulk delete operations on download clients.
- **GET /api/v1/downloadclient/schema**: Get the schema for download client objects.
- **POST /api/v1/downloadclient/test**: Test a download client.
- **POST /api/v1/downloadclient/testall**: Test all download clients.
- **POST /api/v1/downloadclient/action/{name}**: Perform a custom action on download clients.
```

--------------------------------

### Localization API

Source: https://prowlarr.com/docs/api

Endpoints for managing localization settings and options.

```APIDOC
## Localization API

### Description
Manage language and localization settings for Prowlarr.

### Endpoints

- **GET /api/v1/localization**: Get current localization settings.
- **GET /api/v1/localization/options**: Get available localization options.
```

--------------------------------

### System Management API

Source: https://prowlarr.com/docs/api

Endpoints for managing the Prowlarr system, including status, shutdown, and restart.

```APIDOC
## System Management API

### Description
Control and monitor the Prowlarr system, including its status, running tasks, and lifecycle operations.

### Endpoints

- **GET /api/v1/system/status**: Get the current status of the Prowlarr system.
- **GET /api/v1/system/routes**: Get a list of all defined routes in the system.
- **GET /api/v1/system/routes/duplicate**: Get a list of duplicate routes.
- **POST /api/v1/system/shutdown**: Gracefully shut down the Prowlarr service.
- **POST /api/v1/system/restart**: Restart the Prowlarr service.
- **GET /api/v1/system/task**: Get a list of scheduled tasks.
- **GET /api/v1/system/task/{id}**: Get details of a specific task.
```

--------------------------------

### AppProfile API

Source: https://prowlarr.com/docs/api

Endpoints for managing application profiles, used for organizing and applying settings to applications.

```APIDOC
## AppProfile API

### Description
Manage application profiles, which allow for the grouping and management of application configurations.

### Endpoints

- **POST /api/v1/appprofile**: Create a new application profile.
- **GET /api/v1/appprofile**: Retrieve a list of all application profiles.
- **DELETE /api/v1/appprofile/{id}**: Delete an application profile by ID.
- **PUT /api/v1/appprofile/{id}**: Update an application profile by ID.
- **GET /api/v1/appprofile/{id}**: Retrieve a specific application profile by ID.
- **GET /api/v1/appprofile/schema**: Get the schema for application profile objects.
```

--------------------------------

### Application Management API

Source: https://prowlarr.com/docs/api

Endpoints for managing applications, including testing, bulk operations, and schema retrieval.

```APIDOC
## Application Management API

### Description
Manage applications within Prowlarr, including adding, updating, deleting, testing, and performing bulk operations.

### Endpoints

- **GET /api/v1/applications/{id}**: Get a specific application by ID.
- **PUT /api/v1/applications/{id}**: Update a specific application.
- **DELETE /api/v1/applications/{id}**: Delete a specific application.
- **GET /api/v1/applications**: Get a list of all applications.
- **POST /api/v1/applications**: Add a new application.
- **PUT /api/v1/applications/bulk**: Perform bulk update operations on applications.
- **DELETE /api/v1/applications/bulk**: Perform bulk delete operations on applications.
- **GET /api/v1/applications/schema**: Get the schema for application objects.
- **POST /api/v1/applications/test**: Test an application.
- **POST /api/v1/applications/testall**: Test all applications.
- **POST /api/v1/applications/action/{name}**: Perform a custom action on applications.
```

--------------------------------

### Authentication API

Source: https://prowlarr.com/docs/api

Endpoints for user authentication, including login and logout functionality.

```APIDOC
## Authentication API

### Description
Handles user authentication for accessing the Prowlarr API.

### Endpoints

- **POST /login**: Authenticate users and obtain an access token.
- **GET /logout**: Log out the current user and invalidate the session.
```

--------------------------------

### Indexer Proxy API

Source: https://prowlarr.com/docs/api

Endpoints for managing indexer proxies, including testing, bulk operations, and schema retrieval.

```APIDOC
## Indexer Proxy API

### Description
Manage indexer proxies, which can be used to route requests to indexers.

### Endpoints

- **GET /api/v1/indexerproxy/{id}**: Get a specific indexer proxy by ID.
- **PUT /api/v1/indexerproxy/{id}**: Update a specific indexer proxy.
- **DELETE /api/v1/indexerproxy/{id}**: Delete a specific indexer proxy.
- **GET /api/v1/indexerproxy**: Get a list of all indexer proxies.
- **POST /api/v1/indexerproxy**: Add a new indexer proxy.
- **GET /api/v1/indexerproxy/schema**: Get the schema for indexer proxy objects.
- **POST /api/v1/indexerproxy/test**: Test an indexer proxy.
- **POST /api/v1/indexerproxy/testall**: Test all indexer proxies.
- **POST /api/v1/indexerproxy/action/{name}**: Perform a custom action on indexer proxies.
```

--------------------------------

### Log API

Source: https://prowlarr.com/docs/api

Endpoints for retrieving Prowlarr logs.

```APIDOC
## Log API

### Description
Access and retrieve log files generated by Prowlarr.

### Endpoints

- **GET /api/v1/log**: Get the main Prowlarr log.
- **GET /api/v1/log/file**: Get a list of available log files.
- **GET /api/v1/log/file/{filename}**: Get the content of a specific log file.
```

--------------------------------

### Update Log File API

Source: https://prowlarr.com/docs/api

Endpoints for retrieving log files related to updates.

```APIDOC
## Update Log File API

### Description
Access log files specifically related to the update process.

### Endpoints

- **GET /api/v1/log/file/update**: Get the main update log file.
- **GET /api/v1/log/file/update/{filename}**: Get a specific update log file by name.
```

--------------------------------

### Indexer Management API

Source: https://prowlarr.com/docs/api

Endpoints for managing indexers, including testing, bulk operations, and schema retrieval.

```APIDOC
## Indexer Management API

### Description
Manage indexers configured in Prowlarr, including adding, updating, deleting, testing, and performing bulk operations.

### Endpoints

- **GET /api/v1/indexer/{id}**: Get a specific indexer by ID.
- **PUT /api/v1/indexer/{id}**: Update a specific indexer.
- **DELETE /api/v1/indexer/{id}**: Delete a specific indexer.
- **GET /api/v1/indexer**: Get a list of all indexers.
- **POST /api/v1/indexer**: Add a new indexer.
- **PUT /api/v1/indexer/bulk**: Perform bulk update operations on indexers.
- **DELETE /api/v1/indexer/bulk**: Perform bulk delete operations on indexers.
- **GET /api/v1/indexer/schema**: Get the schema for indexer objects.
- **POST /api/v1/indexer/test**: Test an indexer.
- **POST /api/v1/indexer/testall**: Test all indexers.
- **POST /api/v1/indexer/action/{name}**: Perform a custom action on indexers.
```

--------------------------------

### Tag Details API

Source: https://prowlarr.com/docs/api

Endpoints for retrieving detailed information about tags.

```APIDOC
## Tag Details API

### Description
Retrieve detailed information associated with tags.

### Endpoints

- **GET /api/v1/tag/detail/{id}**: Get detailed information for a specific tag.
- **GET /api/v1/tag/detail**: Get detailed information for all tags.
```

--------------------------------

### Notification API

Source: https://prowlarr.com/docs/api

Endpoints for managing notification services, including testing and bulk operations.

```APIDOC
## Notification API

### Description
Manage notification services configured in Prowlarr, allowing for alerts and messages to be sent.

### Endpoints

- **GET /api/v1/notification/{id}**: Get a specific notification service by ID.
- **PUT /api/v1/notification/{id}**: Update a specific notification service.
- **DELETE /api/v1/notification/{id}**: Delete a specific notification service.
- **GET /api/v1/notification**: Get a list of all notification services.
- **POST /api/v1/notification**: Add a new notification service.
- **GET /api/v1/notification/schema**: Get the schema for notification service objects.
- **POST /api/v1/notification/test**: Test a notification service.
- **POST /api/v1/notification/testall**: Test all notification services.
- **POST /api/v1/notification/action/{name}**: Perform a custom action on notification services.
```

--------------------------------

### Ping API

Source: https://prowlarr.com/docs/api

Endpoints to check if the Prowlarr service is running.

```APIDOC
## Ping API

### Description
Check the availability of the Prowlarr API.

### Endpoints

- **GET /ping**: Returns a 200 OK response if the API is running.
- **HEAD /ping**: Returns a 200 OK response if the API is running (HEAD request).
```

--------------------------------

### History API

Source: https://prowlarr.com/docs/api

Endpoints for retrieving historical data, including download history and indexer history.

```APIDOC
## History API

### Description
Retrieve historical data related to downloads and indexer activity.

### Endpoints

- **GET /api/v1/history**: Get the general history.
- **GET /api/v1/history/since**: Get history since a specific point in time.
- **GET /api/v1/history/indexer**: Get history filtered by indexer.
```

--------------------------------

### Tag API

Source: https://prowlarr.com/docs/api

Endpoints for managing tags, used for organizing and categorizing items.

```APIDOC
## Tag API

### Description
Manage tags, which can be used to categorize and organize various entities within Prowlarr.

### Endpoints

- **GET /api/v1/tag/{id}**: Get a specific tag by ID.
- **PUT /api/v1/tag/{id}**: Update a specific tag.
- **DELETE /api/v1/tag/{id}**: Delete a specific tag.
- **GET /api/v1/tag**: Get a list of all tags.
- **POST /api/v1/tag**: Create a new tag.
```

--------------------------------

### Search API

Source: https://prowlarr.com/docs/api

Endpoints for performing searches across configured indexers.

```APIDOC
## Search API

### Description
Perform searches for content across your configured indexers.

### Endpoints

- **POST /api/v1/search**: Perform a search with specified criteria.
- **GET /api/v1/search**: Get search results (likely cached or recent).
- **POST /api/v1/search/bulk**: Perform multiple searches simultaneously.
```

--------------------------------

### Update API

Source: https://prowlarr.com/docs/api

Endpoint for checking for available Prowlarr updates.

```APIDOC
## Update API

### Description
Check for the latest available updates for Prowlarr.

### Endpoints

- **GET /api/v1/update**: Returns information about available updates.
```

--------------------------------

### Indexer Status API

Source: https://prowlarr.com/docs/api

Endpoint for retrieving the status of indexers.

```APIDOC
## Indexer Status API

### Description
Get the current operational status of indexers.

### Endpoints

- **GET /api/v1/indexerstatus**: Returns the status of all indexers.
```

--------------------------------

### Indexer Stats API

Source: https://prowlarr.com/docs/api

Endpoint for retrieving statistics related to indexers.

```APIDOC
## Indexer Stats API

### Description
Retrieve statistics and performance data for indexers.

### Endpoints

- **GET /api/v1/indexerstats**: Returns statistics for all indexers.
```

--------------------------------

### Custom Filter API

Source: https://prowlarr.com/docs/api

Endpoints for managing custom filters used for filtering indexer results.

```APIDOC
## Custom Filter API

### Description
Manage custom filters that can be applied to indexer results.

### Endpoints

- **GET /api/v1/customfilter/{id}**: Get a specific custom filter by ID.
- **PUT /api/v1/customfilter/{id}**: Update a specific custom filter.
- **DELETE /api/v1/customfilter/{id}**: Delete a specific custom filter.
- **GET /api/v1/customfilter**: Get a list of all custom filters.
- **POST /api/v1/customfilter**: Create a new custom filter.
```

--------------------------------

### Indexer Default Categories API

Source: https://prowlarr.com/docs/api

Endpoint for retrieving default categories for indexers.

```APIDOC
## Indexer Default Categories API

### Description
Get the default categories available for indexers.

### Endpoints

- **GET /api/v1/indexer/categories**: Returns the default categories for indexers.
```

--------------------------------

### Health API

Source: https://prowlarr.com/docs/api

Endpoint to check the health status of the Prowlarr service.

```APIDOC
## Health API

### Description
Check the operational status of the Prowlarr service.

### Endpoints

- **GET /api/v1/health**: Returns the health status of the Prowlarr instance.
```
Tokens:
Raw