Download Clients#

Radarr is linked to one or more download clients to actually handle downloading releases that have been grabbed from indexers.

There are two types of download clients: Usenet clients, which grab releases from Usenet indexers, and torrent download clients, which download (and subsequently seed) releases using the BitTorrent P2P protocol.

---

radarr:
  settings:
    download_clients:
      delete_unmanaged: true
      definitions:
        Transmission:  # Name of the download client
          type: transmission  # Type of download client
          enable: true  # Enable the download client in Radarr
          host: transmission
          port: 9091
          category: radarr
          # Define any other type-specific or global
          # download client attributes as needed.
        ...

In Buildarr, download clients are defined using a dictionary structure, as shown above.

The following parameters control how Buildarr configures download clients on Radarr instances.

delete_unmanaged: bool = False class-attribute instance-attribute #

Automatically delete download clients not defined in Buildarr.

definitions: Dict[str, Annotated[DownloadClientType, Field(discriminator='type')]] = {} class-attribute instance-attribute #

Define download clients under this attribute.

Aria2#

Download client for torrent releases using the Aria2 download utility.

type: Literal['aria2'] = 'aria2' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Aria2 host name.

port: Port = 6800 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

rpc_path: NonEmptyStr = '/rpc' class-attribute instance-attribute #

XML RPC path in the Aria2 client URL.

secret_token: Password instance-attribute #

Secret token to use to authenticate with the download client.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Deluge#

Download client for torrent releases using the Deluge torrent client.

type: Literal['deluge'] = 'deluge' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Deluge host name.

port: Port = 8112 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the Deluge JSON URL, e.g. http://[host]:[port]/[url_base]/json.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = 'radarr' class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

recent_priority: DelugePriority = DelugePriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 14 days.

Values:

  • last
  • first
older_priority: DelugePriority = DelugePriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within over 14 days ago.

Values:

  • last
  • first
add_paused: bool = False class-attribute instance-attribute #

When set to true, add releases to the download client in paused state.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Download Station (Torrent)#

Download client for torrent releases using the Download Station download utility.

type: Literal['downloadstation-torrent'] = 'downloadstation-torrent' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Download Station host name.

port: Port = 5000 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category. Creates a [category] subdirectory in the output directory.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

directory: Optional[str] = None class-attribute instance-attribute #

Optional shared folder to put downloads into.

Leave blank, set to null or undefined to use the default download client location.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Download Station (Usenet)#

Download client for Usenet releases using the Download Station download utility.

type: Literal['downloadstation-usenet'] = 'downloadstation-usenet' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Download Station host name.

port: Port = 5000 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category. Creates a [category] subdirectory in the output directory.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

directory: Optional[str] = None class-attribute instance-attribute #

Optional shared folder to put downloads into.

Leave blank, set to null or undefined to use the default download client location.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Flood#

Download client for torrent releases using the Flood torrent client.

Flood download client.

type: Literal['flood'] = 'flood' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

Flood download client.

hostname: NonEmptyStr instance-attribute #

Flood host name.

port: Port = 3000 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Optionally adds a prefix to Flood API, such as [protocol]://[host]:[port]/[url_base]api.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

destination: Optional[str] = None class-attribute instance-attribute #

Manually specified download destination.

flood_tags: Set[NonEmptyStr] = {'radarr'} class-attribute instance-attribute #

Initial tags of a download within Flood.

To be recognized, a download must have all initial tags. This avoids conflicts with unrelated downloads.

additional_tags: Set[FloodMediaTag] = set() class-attribute instance-attribute #

Adds properties of media as tags within Flood.

Multiple can be specified at a time.

Values:

  • collection
  • quality
  • languages
  • release-group
  • year
  • indexer
  • studio
add_paused: bool = False class-attribute instance-attribute #

Add media to the download client in the Paused state.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Freebox#

Download client for torrent releases using a Freebox instance.

type: Literal['freebox'] = 'freebox' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

port: Port = 443 class-attribute instance-attribute #

Freebox access port.

Set to the HTTPS default port as Freebox uses HTTPS by default.

use_ssl: bool = True class-attribute instance-attribute #

Use a secure connection when connecting to the Freebox API.

api_url: NonEmptyStr = '/api/v1' class-attribute instance-attribute #

Define Freebox API base URL with API version, e.g. http[s]://<host>:<port>/<api_url>/.

app_id: NonEmptyStr instance-attribute #

App ID used to authenticate with the Freebox.

app_token: Password instance-attribute #

Unique token used to authenticate with the Freebox.

destination_directory: Optional[str] = None class-attribute instance-attribute #

Optional location to put downloads in, on the Freebox node.

Leave blank, undefined or set to null to use the default Freebox download location.

category: Optional[str] = None class-attribute instance-attribute #

Default category to classify downloads under if no category mappings apply to it.

This will create a [category] subdirectory in the output directory. Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads.

recent_priority: FreeboxPriority = FreeboxPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 14 days.

older_priority: FreeboxPriority = FreeboxPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released over 14 days ago.

add_paused: bool = False class-attribute instance-attribute #

Add media to the download client in the Paused state.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Hadouken#

Download client for torrent releases using the Hadouken torrent client.

type: Literal['hadouken'] = 'hadouken' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Hadouken host name.

port: Port = 7070 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the Hadouken url, e.g. http://[host]:[port]/[url_base]/api.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: NonEmptyStr = 'radarr' class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

NZBGet#

Download client for Usenet releases using the NZBGet Usenet client.

type: Literal['nzbget'] = 'nzbget' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

NZBGet host name.

port: Port = 5000 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the NZBGet url, e.g. http://[host]:[port]/[url_base]/jsonrpc.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

recent_priority: NzbgetPriority = NzbgetPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 21 days.

Values:

  • verylow
  • low
  • normal
  • high
  • veryhigh
  • force
older_priority: NzbgetPriority = NzbgetPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released over 21 days ago.

Values:

  • verylow
  • low
  • normal
  • high
  • veryhigh
  • force
add_paused: bool = False class-attribute instance-attribute #

Add media to the download client in the paused state.

This option requires NZBGet version 16.0 or later.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

NZBVortex#

Download client for Usenet releases using the NZBVortex Usenet client.

type: Literal['nzbvortex'] = 'nzbvortex' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

NZBVortex host name.

port: Port = 4321 class-attribute instance-attribute #

Download client access port.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the NZBVortex url, e.g. http://[host]:[port]/[url_base]/api.

api_key: Password instance-attribute #

API key to use to authenticate with the download client.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

recent_priority: NzbvortexPriority = NzbvortexPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 21 days.

Values:

  • low
  • normal
  • high
older_priority: NzbvortexPriority = NzbvortexPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released over 21 days ago.

Values:

  • low
  • normal
  • high
remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Pneumatic#

Download client for Usenet releases using the Pneumatic add-on for Kodi (XBMC).

type: Literal['pneumatic'] = 'pneumatic' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

nzb_folder: NonEmptyStr instance-attribute #

Folder in which Radarr will store .nzb files.

This folder will need to be reachable from Kodi/XMBC.

strm_folder: NonEmptyStr instance-attribute #

Folder from which .strm files will be imported by Drone.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

qBittorrent#

Download client for torrent releases using the qBittorrent torrent client.

type: Literal['qbittorrent'] = 'qbittorrent' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

qBittorrent host name.

port: Port = 8080 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the qBittorrent URL, e.g. http://[host]:[port]/[url_base]/api.

username: Optional[str] = None class-attribute instance-attribute #

User name to use when authenticating with the download client, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password to use to authenticate the download client user, if required.

category: Optional[str] = 'radarr' class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

postimport_category: Optional[str] = None class-attribute instance-attribute #

Category for Radarr to set after it has imported the download. Radarr will not remove the torrent if seeding has finished.

Leave blank to keep the same category as set in category.

recent_priority: QbittorrentPriority = QbittorrentPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 14 days.

Values:

  • last
  • first
older_priority: QbittorrentPriority = QbittorrentPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released over 14 days ago.

Values:

  • last
  • first
initial_state: QbittorrentState = QbittorrentState.start class-attribute instance-attribute #

Initial state for torrents added to qBittorrent.

Note that forced torrents do not abide by seed restrictions.

sequential_order: bool = False class-attribute instance-attribute #

When set to true, download pieces in sequential order.

Requires qBittorrent v4.1.0 or later.

first_and_last_first: bool = False class-attribute instance-attribute #

When set to true, download the first and last pieces first.

Requires qBittorrent v4.1.0 or later.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

RTorrent (ruTorrent)#

Download client for torrent releases using the RTorrent (ruTorrent) torrent client.

type: Literal['rtorrent', 'rutorrent'] = 'rtorrent' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

RTorrent host name.

port: Port = 8080 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: NonEmptyStr = 'RPC2' class-attribute instance-attribute #

Path to the XMLRPC endpoint, e.g. http(s)://[host]:[port]/[url_base].

When using RTorrent this usually is RPC2 or plugins/rpc/rpc.php.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = 'radarr' class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

postimport_category: Optional[str] = None class-attribute instance-attribute #

Category for Radarr to set after it has imported the download. Radarr will not remove the torrent if seeding has finished.

Leave blank to keep the same category as set in category.

directory: Optional[str] = None class-attribute instance-attribute #

Optional shared folder to put downloads into.

Leave blank, set to null or undefined to use the default download client location.

recent_priority: RtorrentPriority = RtorrentPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 14 days.

Values:

  • do-not-download
  • low
  • normal
  • high
older_priority: RtorrentPriority = RtorrentPriority.normal class-attribute instance-attribute #

Priority to use when grabbing media that released over 14 days ago.

Values:

  • do-not-download
  • low
  • normal
  • high
add_stopped: bool = False class-attribute instance-attribute #

Enabling will add torrents and magnets to RTorrent in a stopped state.

This may break magnet files.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

SABnzbd#

Download client for Usenet releases using the SABnzbd Usenet client.

type: Literal['sabnzbd'] = 'sabnzbd' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

SABnzbd host name.

port: Port = 4321 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the SABnzbd URL, e.g. http://[host]:[port]/[url_base]/api/.

api_key: Optional[SecretStr] = None class-attribute instance-attribute #

API key to use to authenticate with SABnzbd, if required.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

recent_priority: SabnzbdPriority = SabnzbdPriority.default class-attribute instance-attribute #

Priority to use when grabbing media that releases within the last 21 days.

Values:

  • default
  • paused
  • low
  • normal
  • high
  • force
older_priority: SabnzbdPriority = SabnzbdPriority.default class-attribute instance-attribute #

Priority to use when grabbing media that releases over 21 days ago.

Values:

  • default
  • paused
  • low
  • normal
  • high
  • force
remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Torrent Blackhole#

Use .torrent files and watch folders to manage requests to an externally managed download client.

type: Literal['torrent-blackhole'] = 'torrent-blackhole' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

torrent_folder: NonEmptyStr instance-attribute #

Folder in which Radarr will store .torrent files.

watch_folder: NonEmptyStr instance-attribute #

Folder from which Radarr should import completed downloads.

save_magnet_files: bool = False class-attribute instance-attribute #

Save the magnet link if no .torrent file is available.

Only useful if the download client supports magnets saved to a file.

magnet_file_extension: NonEmptyStr = '.magnet' class-attribute instance-attribute #

Extension to use for magnet links.

read_only: bool = True class-attribute instance-attribute #

When set to true, this instructs Radarr to copy or hard link completed downloads to their final directory, instead of moving them.

To allow torrents to continue seeding after download, this should be enabled.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Transmission#

Download client for torrent releases using the Transmission torrent client.

type: Literal['transmission'] = 'transmission' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Download client host name.

port: Port = 9091 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: NonEmptyStr = '/transmission/' class-attribute instance-attribute #

Adds a prefix to the API RPC url, e.g.http://[host]:[port][url_base]rpc.

This is set by default in most clients to /transmission/.

username: Optional[str] = None class-attribute instance-attribute #

User name to use when authenticating with the download client, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password to use to authenticate the download client user, if required.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category. Creates a [category] subdirectory in the output directory.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

directory: Optional[str] = None class-attribute instance-attribute #

Optional shared folder to put downloads into.

Leave blank, set to null or undefined to use the default download client location.

recent_priority: TransmissionPriority = TransmissionPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 21 days.

Values:

  • last
  • first
older_priority: TransmissionPriority = TransmissionPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released over 21 days ago.

Values:

  • last
  • first
add_paused: bool = False class-attribute instance-attribute #

Add media to the download client in the Paused state.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Usenet Blackhole#

Use .nzb files and watch folders to manage requests to an externally managed download client.

type: Literal['usenet-blackhole'] = 'usenet-blackhole' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

nzb_folder: NonEmptyStr instance-attribute #

Folder in which Radarr will store .nzb files.

watch_folder: NonEmptyStr instance-attribute #

Folder from which Radarr should import completed downloads.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

uTorrent#

type: Literal['utorrent'] = 'utorrent' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

uTorrent host name.

port: Port = 8080 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: Optional[str] = None class-attribute instance-attribute #

Adds a prefix to the uTorrent URL, e.g. http://[host]:[port]/[url_base]/api.

username: NonEmptyStr instance-attribute #

User name to use when authenticating with the download client.

password: Password instance-attribute #

Password to use to authenticate the download client user.

category: Optional[str] = 'radarr' class-attribute instance-attribute #

Associate media from Radarr with a category.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

postimport_category: Optional[str] = 'radarr' class-attribute instance-attribute #

Category for Radarr to set after it has imported the download. Radarr will not remove the torrent if seeding has finished.

Leave blank to keep the same category as set in category.

recent_priority: UtorrentPriority = UtorrentPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 21 days.

Values:

  • last
  • first
older_priority: UtorrentPriority = UtorrentPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released over 21 days ago.

Values:

  • last
  • first
initial_state: UtorrentState = UtorrentState.start class-attribute instance-attribute #

Initial state for torrents added to uTorrent.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.

Vuze#

Download client for torrent releases using the Vuze torrent client.

type: Literal['vuze'] = 'vuze' class-attribute instance-attribute #

Type value associated with this kind of download client.

enable: bool = True class-attribute instance-attribute #

When True, this download client is active and Radarr is able to send requests to it.

hostname: NonEmptyStr instance-attribute #

Download client host name.

port: Port = 9091 class-attribute instance-attribute #

Download client access port.

use_ssl: bool = False class-attribute instance-attribute #

Use a secure connection when connecting to the download client.

url_base: NonEmptyStr = '/transmission/' class-attribute instance-attribute #

Adds a prefix to the API RPC url, e.g.http://[host]:[port][url_base]rpc.

This is set by default in most clients to /transmission/.

username: Optional[str] = None class-attribute instance-attribute #

User name to use when authenticating with the download client, if required.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password to use to authenticate the download client user, if required.

category: Optional[str] = None class-attribute instance-attribute #

Associate media from Radarr with a category. Creates a [category] subdirectory in the output directory.

Adding a category specific to Radarr avoids conflicts with unrelated non-Radarr downloads. Using a category is optional, but strongly recommended.

directory: Optional[str] = None class-attribute instance-attribute #

Optional shared folder to put downloads into.

Leave blank, set to null or undefined to use the default download client location.

recent_priority: TransmissionPriority = TransmissionPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released within the last 21 days.

Values:

  • last
  • first
older_priority: TransmissionPriority = TransmissionPriority.last class-attribute instance-attribute #

Priority to use when grabbing media that released over 21 days ago.

Values:

  • last
  • first
add_paused: bool = False class-attribute instance-attribute #

Add media to the download client in the Paused state.

remove_completed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove completed downloads from the download client history.

remove_failed_downloads: bool = True class-attribute instance-attribute #

When set to true, remove failed downloads from the download client history.

priority: PositiveInt = 1 class-attribute instance-attribute #

Download client priority.

Clients with a lower value are prioritised. Round-robin is used for clients with the same priority.

tags: Set[NonEmptyStr] = set() class-attribute instance-attribute #

Radarr tags to assign to the download clients. Only media under those tags will be assigned to this client.

If no tags are assigned, all media can use the client.