Type object
File match **/.flexget/config.yml **/flexget/config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/flexget-config/latest.json
Source https://github.com/Flexget/Flexget/releases/latest/download/flexget-config.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

tasks Record<string, object> required

All tasks which can be run by FlexGet are defined in this section

templates Record<string, object>
log_filter array
minItems=1
web_server boolean | integer | object
schedules object[] | boolean

Runs tasks periodically (when FlexGet is run as a daemon)

variables string | boolean | object
irc object | boolean

Definitions

plugins?interface=task object
rtorrent object
17 nested properties
uri string required
username string
password string
digest_auth boolean
Default: false
start boolean
Default: true
mkdir boolean
Default: true
action string
Default: "add"
Values: "update" "delete" "add" "purge"
message string
priority string
path string
custom1 string
custom2 string
custom3 string
custom4 string
custom5 string
fast_resume boolean
Default: false
custom_fields Record<string, string>
from_rtorrent object
7 nested properties
uri string required
username string
password string
digest_auth boolean
Default: false
view string
Default: "main"
fields string[] | string
custom_fields string[]
nzbget object
4 nested properties
url string required
category string
Default: ""
priority integer
Default: 0
top boolean
Default: false
aria2 object
12 nested properties
path string required
server string
Default: "localhost"
port integer
Default: 6800
secret string
Default: ""
username string
Default: ""
password string
Default: ""
scheme string
Default: "http"
rpc_mode string
Default: "xml"
Values: "xml" "json"
rpc_path string
Default: "rpc"
filename string
add_extension string | boolean
Default: "no"
options Record<string, string | number | boolean>
transmission boolean | object
from_transmission boolean | object
clean_transmission boolean | object
pyload object
13 nested properties
username string required
password string required
api string
folder string
package string
package_password string
queue boolean
parse_url boolean
multiple_hoster boolean
hoster string[] | string
preferred_hoster_only boolean
handle_no_url_as_failure boolean
enabled boolean
qbittorrent boolean | object
from_qbittorrent object
6 nested properties
username string required
password string required
host string required
port integer required
category string
completed boolean
from_deluge boolean | object
deluge boolean | object
change_warn
best_quality object
4 nested properties
identified_by string
Default: "auto"
on_best string
Default: "do_nothing"
Values: "accept" "reject" "do_nothing"
on_lower string
Default: "reject"
Values: "accept" "reject" "do_nothing"
single_best boolean
Default: true
content_filter object
8 nested properties
min_files integer
max_files integer
require string | string[] | object
require_all string | string[] | object
reject string | string[] | object
require_mainfile boolean
Default: false
strict boolean
Default: false
regexp_mode boolean
Default: false
timeframe object
5 nested properties
target string required
format=quality_requirements
wait string required
format=interval
identified_by string
Default: "auto"
on_waiting string
Default: "reject"
Values: "accept" "reject" "do_nothing"
on_reached string
Default: "do_nothing"
Values: "accept" "reject" "do_nothing"
magnets boolean
age object
3 nested properties
field string required
action string required
Values: "accept" "reject"
age string required
format=interval
exists_series string[] | string | object
thetvdb object
16 nested properties
min_series_rating number
min_episode_rating number
min_episode_air_year integer
max_episode_air_year integer
min_episode_runtime number
max_episode_runtime number
reject_content_rating string[]
accept_content_rating string[]
accept_network string[]
reject_network string[]
reject_genres string[]
reject_status string[]
accept_actors string[]
reject_actors string[]
accept_directors string[]
reject_directors string[]
delay string
format=interval
require_field string[] | string
rottentomatoes object
14 nested properties
min_year integer
max_year integer
min_critics_score number
min_audience_score number
min_average_score number
min_critics_rating enum
Values: "rotten" "fresh" "certified fresh"
min_audience_rating enum
Values: "spilled" "upright"
reject_genres string[]
reject_actors string[]
accept_actors string[]
reject_directors string[]
accept_directors string[]
reject_mpaa_ratings string[]
accept_mpaa_ratings string[]
proper_movies boolean | string
only_new boolean
quality string[] | string
exists string[] | string
crossmatch object
6 nested properties
fields string[] required
action enum required
Values: "accept" "reject"
from plugins?phase=input[] required
exact boolean
Default: true
all_fields boolean
Default: false
case_sensitive boolean
Default: true
upgrade object
6 nested properties
identified_by string
tracking boolean
target string
format=quality_requirements
on_lower string
Values: "accept" "reject" "do_nothing"
timeframe string
format=interval
propers boolean
accept_all boolean

Accepts all entries

content_size object
3 nested properties
min number | string
format=size
max number | string
format=size
strict boolean
Default: true
duplicates object
2 nested properties
field string required
action enum required
Values: "accept" "reject"
abort_if_exists object
2 nested properties
regexp string required
format=regex
field string required
limit_new integer
min=1
exists_movie string[] | string | object
unique object
2 nested properties
field string[] | string required
action enum
Values: "accept" "reject"
regexp object
6 nested properties
accept_excluding string | object[]
reject_excluding string | object[]
rest string
Values: "accept" "reject"
from string[] | string
include string[] | string
proxy string | object
version_checker
form object
5 nested properties
url string required
format=url
username string required
password string required
userfield string
passfield string
free_space number | object
sequence plugins[]
verbose
interval string
format=interval
cookies string | object
template template[] | boolean
details
no_entries_ok boolean
disable string[] | string
domain_delay Record<string, string>
entry_operations
run_task object
2 nested properties
task string[] | string required
when string[] | string
digest string | object
from_digest object
4 nested properties
list string required
limit integer
expire string | boolean
Default: true
restore_state boolean
Default: false
spy_headers boolean
pathscrub string
Values: "windows" "linux" "mac"
max_reruns integer
verify_ssl_certificates boolean
manual boolean

Prevents this task from running unless it is explicitly specified with --tasks, or in a schedule

disable_phases string[]
abort
log_filter array
minItems=1
rerun integer
sleep object | integer
priority integer
delete boolean | object
copy boolean | object
move boolean | object
sns object
6 nested properties
sns_topic_arn string required
aws_region string required
sns_notification_template string
Default: "{"entry": {"title": "{{title}}", "url": "{{url}}", "original_url": "{{original_url}}", "series": "{{series_name}}", "series_id": "{{series_id}}"}, "task": "{{task}}"}"
aws_access_key_id string
aws_secret_access_key string
profile_name string
exec string[] | string | object
mock_output boolean
make_rss string | object
rtorrent_magnet string
format=path
symlink object | string
make_html object
2 nested properties
file string required
template string
subliminal object
8 nested properties
languages string[] required
minItems=1
alternatives string[]
exact_match boolean
Default: true
providers string[]
single boolean
Default: true
directory string
hearing_impaired boolean
Default: false
authentication object
9 nested properties
addic7ed object
gestdown object
napiprojekt object
opensubtitles object
opensubtitlescom object
opensubtitlescomvip object
opensubtitlesvip object
podnapisi object
tvsubtitles object
download_auth array
minItems=1
periscope object
4 nested properties
languages string[]
minItems=1
alternatives string[]
overwrite boolean
Default: false
subexts string[]
Default:
[
  "srt",
  "stp",
  "sub",
  "stl",
  "ssa"
]
dump boolean
sabnzbd object
8 nested properties
key string required
url string required
format=url
category string
script string
pp string
priority integer
password string
username string
dump_config
subtitles object
4 nested properties
languages string[]
Default:
[
  "eng"
]
min_sub_rating number
Default: 0.0
match_limit number
Default: 0.8
output string
format=path
utorrent object
4 nested properties
url string required
format=url
username string required
password string required
path string
download object | string | boolean
urlfix boolean
pogcal_acquired object
2 nested properties
username string required
password string required
kodi_library object
7 nested properties
action string required
Values: "clean" "scan"
category string required
Values: "audio" "video"
url string required
format=url
port integer
Default: 8080
username string
password string
only_on_accepted boolean
Default: true
myepisodes object
2 nested properties
username string required
password string required
metainfo_media_id boolean
rottentomatoes_lookup boolean | string
metainfo_movie boolean
assume_quality string | object
nfo_lookup boolean
check_subtitles boolean
metainfo_quality boolean
bluray_lookup boolean
metainfo_content_size boolean
Default: false
metainfo_task boolean
nzb_size
sort_by_weight object[]
minItems=2
path_by_space object
4 nested properties
select string required
Values: "most_free" "most_used" "most_free_percent" "most_used_percent"
paths string[] | string required
to_field string
Default: "path"
within string | string
plugin_priority Record<string, integer>
path_by_ext object
set object
sort_by string | object[] | string | object
reorder_quality Record<string, object>
headers Record<string, string>
regex_extract object
3 nested properties
prefix string
field string
regex string[] | string
extension string | number
manipulate object[]
medusa object
6 nested properties
base_url string required
format=uri
username string required
password string required
port number
Default: 8081
only_monitored boolean
Default: false
include_ended boolean
Default: false
twitterfeed object
7 nested properties
account string required
consumer_key string required
consumer_secret string required
access_token_key string required
access_token_secret string required
all_entries boolean
Default: true
tweets number
Default: 50
tail object
4 nested properties
file string required
format=file
entry object required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
next_sonarr_episodes object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
page_size number
Default: 50
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
5 nested properties
user_id integer required
pattern=^\d{1,6}$
type string
Default: "movies"
Values: "shows" "movies" "ovas"
mode string
Default: "all"
Values: "all" "undefined" "watch" "get" "blacklist" "buddy"
pass string
strip_dates boolean
Default: false
gazelle object
5 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
gazellemusic object
19 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
redacted object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "concert recording" "dj mix"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
notwhatcd object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray" "Unknown"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "dj mix" "concert recording"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
from_telegram object
5 nested properties
token string required
types string[] | string
whitelist object | object | object[]
minItems=1
only_new boolean
Default: true
entry Record<string, string>
2 nested properties
url string
format=regex
title string
format=regex
filmweb_watchlist object
4 nested properties
login string required

Can be username or email address

password string required
type string
Default: "movies"
Values: "shows" "movies"
min_star integer

Items will be processed with at least this level of "How much I want to see"

Default: 0
Any of: variant, variant
12 nested properties
url string required
Any of: variant, variant
username string
password string
title string
link string[] | string
silent boolean
Default: false
ascii boolean
Default: false
escape boolean
Default: false
filename boolean
group_links boolean
Default: false
all_entries boolean
Default: true
other_fields string | object[]
rlslog string
format=url
text object
4 nested properties
url string | string required
entry Record<string, string> required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
pogcal object
2 nested properties
username string required
password string required
sickbeard object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: false
include_data boolean
Default: false
generate integer
kitsu object
One of: variant, variant
6 nested properties
username string
user_id string
lists string[] | string
type string[] | string
latest boolean
Default: false
status string
Values: "airing" "finished"
csv object
2 nested properties
url string required
format=url
values Record<string, integer> required
sceper string
format=url
plex object
14 nested properties
section string | integer required
server string
Default: "127.0.0.1"
port integer
Default: 32400
username string
password string
token string
selection string
Default: "all"
lowercase_title boolean
Default: false
strip_non_alpha boolean
Default: true
strip_year boolean
Default: true
strip_parens boolean
Default: false
original_filename boolean
Default: false
unwatched_only boolean
Default: false
fetch string
Default: "file"
Values: "file" "art" "cover" "thumb" "season_cover"
json object
3 nested properties
file string required
format=file
encoding string
field_map Record<string, string>
html string | object
apple_trailers object | string
from_piratebay object
5 nested properties
list string required
Default: "top"
Values: "top" "top48h" "recent"
url string
Default: "https://apibay.org"
format=url
category string | integer
query string
rank string
Default: "all"
Values: "all" "user" "member" "trusted" "vip" "helper" "moderator" "supermod"
regexp_parse object
4 nested properties
source string | string required
keys Record<string, object> required
encoding string
sections object[]
letterboxd object
4 nested properties
username string required
list string required
sort_by string
Default: "default"
Values: "default" "added" "length-ascending" "length-descending" "name" "popularity" "rating-ascending" "rating-descending" "release-ascending" "release-descending"
max_results integer
parameterize object
2 nested properties
plugin object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
using object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
anilist string | object
myepisodes_list object
4 nested properties
username string required
password string required
strip_dates boolean
Default: false
include_ignored boolean
Default: false
betaseries_list object
4 nested properties
username string required
password string required
api_key string required
members string[]
rottentomatoes_list object
3 nested properties
dvds enum[]
movies enum[]
api_key string
my_anime_list object
4 nested properties
username string required
status string[] | string
Default: "all"
airing_status string[] | string
Default: "all"
type string[] | string
Default: "all"
npo_watchlist object
5 nested properties
email string required
password string required
remove_accepted boolean
Default: false
max_episode_age_days integer
Default: -1
download_premium boolean
Default: false
limit object
2 nested properties
amount integer required
min=-1
from required
All of: plugins?phase=input object, variant
discover object
5 nested properties
what array required
from array required
interval string
Default: "5 hours"
format=interval
release_estimations string | object
limit integer
min=1
backlog string
format=interval
history boolean
archive boolean | string[]
pending_approval boolean
private_torrents boolean
add_trackers string[]
remove_trackers string[]
modify_trackers object[]
magnet_btih boolean
torrent
torrent_size
torrent_scrub boolean | string | string[]
torrent_match object
2 nested properties
what array required
max_size_difference string
Default: "0%"
format=percent
torrent_files
torrent_alive boolean | integer | object
convert_magnet boolean | object
tmdb_lookup boolean | object
parsing object
2 nested properties
movie string
Values: "guessit" "internal"
series string
Values: "guessit" "internal"
trakt_lookup object | boolean
trakt_list object
Any of: variant, variant, variant
6 nested properties
list string required
username string
account string
type string
Default: "auto"
Values: "shows" "seasons" "episodes" "movies" "auto"
strip_dates boolean
Default: false
language string
minLength=2maxLength=2
trakt_calendar object
5 nested properties
type string required
Values: "shows" "episodes"
start_day integer
Default: 0
days integer
Default: 7
account string
strip_dates boolean
Default: false
next_trakt_episodes object
Any of: variant, variant
6 nested properties
list string required
username string
account string
position string
Default: "next"
Values: "last" "next"
context string
Default: "watched"
Values: "watched" "collected" "aired"
strip_dates boolean
Default: false
thetvdb_lookup boolean | object
decompress boolean | object
archives boolean | object
urlrewriting
disable_urlrewriters string[]
urlrewrite Record<string, object>
urlrewrite_search array
notify object
3 nested properties
entries object
5 nested properties
via array required
title string
Default: "{{ title }}"
message string
Default: "{% if series_name is defined %}{{ tvdb_series_name|d(series_name) }} {{series_id}} {{tvdb_ep_name|d()}}{% elif imdb_name is defined %}{{imdb_name}} {{imdb_year}}{% elif title is defined %}{{ title }}{% endif %}"
template string
what string[] | string
task object
5 nested properties
via array required
title string
Default: "{% if not task.failed and not task.accepted %} Task {{task.name}} did not produce any entries.{% else %} [FlexGet] {{task.name}}:{% if task.failed %} {{task.failed|length}} failed entries.{% endif %}{% if task.accepted %} {{task.accepted|length}} new entries downloaded.{% endif %}{% endif %}"
message string
template string
Default: "default.template"
always_send boolean
Default: false
abort object
3 nested properties
via array required
title string
Default: "Task {{ task.name }} has aborted!"
message string
Default: "Reason: {{ task.abort_reason }}"
seen boolean | string | object
seen_info_hash boolean | string
seen_movies string | object
list_add array
list_match object
4 nested properties
from array
action string
Default: "accept"
Values: "accept" "reject"
remove_on_match boolean
Default: true
single_match boolean
Default: true
list_clear object
2 nested properties
what array required
phase string
Default: "start"
Values: "prepare" "start" "input" "metainfo" "filter" "urlrewrite" "download" "modify" "output" "learn" "exit"
list_remove array
tvmaze_lookup boolean
ftp_list object
10 nested properties
username string required
host string required
password string
port integer
ssl boolean
encoding string
dirs string[] | string
recursion boolean
recursion_depth integer
retrieve string[] | string
sftp_list object
14 nested properties
host string required
username string required
password string
port integer
Default: 22
files_only boolean
Default: true
dirs_only boolean
Default: false
recursive boolean
Default: false
get_size boolean
Default: true
private_key string
private_key_pass string
dirs string[] | string
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
host_key object
2 nested properties
key_type string required
Values: "ssh-rsa" "ssh-ed25519"
public_key string required
sftp_download object
5 nested properties
to string required
format=path
recursive boolean
Default: true
delete_origin boolean
Default: false
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
sftp_upload object
11 nested properties
host string required
username string required
password string
port integer
Default: 22
private_key string
private_key_pass string
to string
delete_origin boolean
Default: false
host_key object
2 nested properties
key_type string required
Values: "ssh-rsa" "ssh-ed25519"
public_key string required
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
ftp_download object
4 nested properties
use-ssl boolean
Default: false
ftp_tmp_path string
format=path
delete_origin boolean
Default: false
download_empty_dirs boolean
Default: false
next_series_episodes boolean | object
series Record<string, string | number | object[]>
1 nested properties
settings Record<string, object>
series_db
all_series boolean | object
gen_series_data object
configure_series object
2 nested properties
from object required
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
settings object
26 nested properties
path string
set object
alternate_name string[] | string
name_regexp string[] | string
ep_regexp string[] | string
date_regexp string[] | string
sequence_regexp string[] | string
id_regexp string[] | string
date_yearfirst boolean
date_dayfirst boolean
quality string
format=quality_requirements
qualities string[]
timeframe string
format=interval
upgrade boolean
target string
format=quality_requirements
specials boolean
propers boolean | string
format=interval
identified_by string
Values: "ep" "date" "sequence" "id" "auto"
exact boolean
begin string | integer
format=episode_or_season_id
from_group string[] | string
parse_only boolean
special_ids string[] | string
prefer_specials boolean
assume_special boolean
season_packs boolean | integer | string | object
metainfo_series boolean
series_premiere boolean | object
set_series_begin boolean
next_series_seasons boolean | object
series_remove boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
2 nested properties
server object | object required
list string required
from_emby object
6 nested properties
server object | object required
list string
types string[] | string
watched boolean
favorite boolean
sort string | object
emby_lookup object | object
emby_refresh object
2 nested properties
server object | object required
when string[] | string
scan_imdb boolean
imdb object
17 nested properties
min_year integer
max_year integer
min_votes integer
min_meta_score integer
min_score number
accept_genres string[]
reject_genres string[]
reject_languages string[]
accept_languages string[]
reject_actors string[]
accept_actors string[]
reject_directors string[]
accept_directors string[]
reject_writers string[]
accept_writers string[]
reject_mpaa_ratings string[]
accept_mpaa_ratings string[]
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
5 nested properties
list string required
One of: enum enum, variant
user_id string
pattern=^ur\d{7,9}$
force_language string
Default: "en-us"
type string[] | string | string
strip_dates boolean
Default: false
imdb_lookup boolean
status boolean
ombi_list object
One of: variant, variant
10 nested properties
url string required
type string required
Values: "shows" "seasons" "episodes" "movies"
api_key string
username string
password string
status string
Default: "approved"
Values: "approved" "requested" "denied" "all"
hide_available boolean
Default: true
on_remove string
Default: "deleted"
Values: "unavailable" "denied" "deleted"
include_year boolean
Default: false
include_ep_title boolean
Default: false
subtitle_list object
8 nested properties
list string required
languages string[]
minItems=1
check_subtitles boolean
Default: true
remove_after string
format=interval
path string
allow_dir boolean
Default: false
recursion_depth integer
Default: 1
min=1
force_file_existence boolean
Default: true
imdb_list object
4 nested properties
login string required
cookies string | string | object required
list string required
force_language string
Default: "en-us"
radarr_list object
9 nested properties
base_url string required
api_key string required
port number
Default: 80
only_monitored boolean
Default: true
include_data boolean
Default: false
only_use_cutoff_quality boolean
Default: false
monitored boolean
Default: true
profile_id integer
Default: 1
tags integer | string[]
plex_watchlist
5 nested properties
username string
password string
token string
type string
Values: "movie" "show"
filter string
Values: "available" "released"
thetvdb_list object
5 nested properties
username string required
account_id string required
api_key string required
strip_dates boolean
language string
sonarr_list object
17 nested properties
api_key string required
base_url string
Default: "http://localhost"
base_path string
Default: ""
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
include_data boolean
Default: false
search_missing_episodes boolean
Default: true
ignore_episodes_without_files boolean
Default: false
ignore_episodes_with_files boolean
Default: false
profile_id integer
Default: 1
language_id integer
Default: 1
season_folder boolean
Default: false
monitored boolean
Default: true
root_folder_path string
series_type string
Default: "standard"
Values: "standard" "daily" "anime"
tags string[]
yaml_list string | object
couchpotato_list object
4 nested properties
base_url string required
api_key string required
port number
Default: 80
include_data boolean
Default: false
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
cronitor object | string
3 nested properties
lf_session string
prefilter boolean
site_urls string | array
format=url
serienjunkies object
2 nested properties
language string
Values: "german" "foreign" "subtitle" "dual"
hoster string
Values: "ul" "cz" "so" "all"
horriblesubs boolean
rutracker_auth object
2 nested properties
username string
password string
wordpress_auth object
3 nested properties
url string required
One of: variant
username string
Default: ""
password string
Default: ""
solidtorrents boolean | object
redirect_url
piratebay boolean | object
rlsbb object
3 nested properties
filehosters_re array
Default:
[]
link_text_re array
Default:
[
  "UPLOADGiG",
  "NiTROFLARE",
  "RAPiDGATOR"
]
parse_comments boolean
Default: false
torrent_cache
plugin
plugins?phase=input object
from_rtorrent object
7 nested properties
uri string required
username string
password string
digest_auth boolean
Default: false
view string
Default: "main"
fields string[] | string
custom_fields string[]
from_transmission boolean | object
from_qbittorrent object
6 nested properties
username string required
password string required
host string required
port integer required
category string
completed boolean
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
4 nested properties
list string required
limit integer
expire string | boolean
Default: true
restore_state boolean
Default: false
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
6 nested properties
base_url string required
format=uri
username string required
password string required
port number
Default: 8081
only_monitored boolean
Default: false
include_ended boolean
Default: false
twitterfeed object
7 nested properties
account string required
consumer_key string required
consumer_secret string required
access_token_key string required
access_token_secret string required
all_entries boolean
Default: true
tweets number
Default: 50
tail object
4 nested properties
file string required
format=file
entry object required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
next_sonarr_episodes object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
page_size number
Default: 50
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
5 nested properties
user_id integer required
pattern=^\d{1,6}$
type string
Default: "movies"
Values: "shows" "movies" "ovas"
mode string
Default: "all"
Values: "all" "undefined" "watch" "get" "blacklist" "buddy"
pass string
strip_dates boolean
Default: false
gazelle object
5 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
gazellemusic object
19 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
redacted object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "concert recording" "dj mix"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
notwhatcd object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray" "Unknown"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "dj mix" "concert recording"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
from_telegram object
5 nested properties
token string required
types string[] | string
whitelist object | object | object[]
minItems=1
only_new boolean
Default: true
entry Record<string, string>
2 nested properties
url string
format=regex
title string
format=regex
filmweb_watchlist object
4 nested properties
login string required

Can be username or email address

password string required
type string
Default: "movies"
Values: "shows" "movies"
min_star integer

Items will be processed with at least this level of "How much I want to see"

Default: 0
Any of: variant, variant
12 nested properties
url string required
Any of: variant, variant
username string
password string
title string
link string[] | string
silent boolean
Default: false
ascii boolean
Default: false
escape boolean
Default: false
filename boolean
group_links boolean
Default: false
all_entries boolean
Default: true
other_fields string | object[]
rlslog string
format=url
text object
4 nested properties
url string | string required
entry Record<string, string> required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
pogcal object
2 nested properties
username string required
password string required
sickbeard object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: false
include_data boolean
Default: false
generate integer
kitsu object
One of: variant, variant
6 nested properties
username string
user_id string
lists string[] | string
type string[] | string
latest boolean
Default: false
status string
Values: "airing" "finished"
csv object
2 nested properties
url string required
format=url
values Record<string, integer> required
sceper string
format=url
plex object
14 nested properties
section string | integer required
server string
Default: "127.0.0.1"
port integer
Default: 32400
username string
password string
token string
selection string
Default: "all"
lowercase_title boolean
Default: false
strip_non_alpha boolean
Default: true
strip_year boolean
Default: true
strip_parens boolean
Default: false
original_filename boolean
Default: false
unwatched_only boolean
Default: false
fetch string
Default: "file"
Values: "file" "art" "cover" "thumb" "season_cover"
json object
3 nested properties
file string required
format=file
encoding string
field_map Record<string, string>
html string | object
apple_trailers object | string
from_piratebay object
5 nested properties
list string required
Default: "top"
Values: "top" "top48h" "recent"
url string
Default: "https://apibay.org"
format=url
category string | integer
query string
rank string
Default: "all"
Values: "all" "user" "member" "trusted" "vip" "helper" "moderator" "supermod"
regexp_parse object
4 nested properties
source string | string required
keys Record<string, object> required
encoding string
sections object[]
letterboxd object
4 nested properties
username string required
list string required
sort_by string
Default: "default"
Values: "default" "added" "length-ascending" "length-descending" "name" "popularity" "rating-ascending" "rating-descending" "release-ascending" "release-descending"
max_results integer
parameterize object
2 nested properties
plugin object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
using object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
anilist string | object
myepisodes_list object
4 nested properties
username string required
password string required
strip_dates boolean
Default: false
include_ignored boolean
Default: false
betaseries_list object
4 nested properties
username string required
password string required
api_key string required
members string[]
rottentomatoes_list object
3 nested properties
dvds enum[]
movies enum[]
api_key string
my_anime_list object
4 nested properties
username string required
status string[] | string
Default: "all"
airing_status string[] | string
Default: "all"
type string[] | string
Default: "all"
npo_watchlist object
5 nested properties
email string required
password string required
remove_accepted boolean
Default: false
max_episode_age_days integer
Default: -1
download_premium boolean
Default: false
limit object
2 nested properties
amount integer required
min=-1
from required
All of: plugins?phase=input object, variant
discover object
5 nested properties
what array required
from array required
interval string
Default: "5 hours"
format=interval
release_estimations string | object
limit integer
min=1
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
6 nested properties
list string required
username string
account string
type string
Default: "auto"
Values: "shows" "seasons" "episodes" "movies" "auto"
strip_dates boolean
Default: false
language string
minLength=2maxLength=2
trakt_calendar object
5 nested properties
type string required
Values: "shows" "episodes"
start_day integer
Default: 0
days integer
Default: 7
account string
strip_dates boolean
Default: false
next_trakt_episodes object
Any of: variant, variant
6 nested properties
list string required
username string
account string
position string
Default: "next"
Values: "last" "next"
context string
Default: "watched"
Values: "watched" "collected" "aired"
strip_dates boolean
Default: false
list_clear object
2 nested properties
what array required
phase string
Default: "start"
Values: "prepare" "start" "input" "metainfo" "filter" "urlrewrite" "download" "modify" "output" "learn" "exit"
ftp_list object
10 nested properties
username string required
host string required
password string
port integer
ssl boolean
encoding string
dirs string[] | string
recursion boolean
recursion_depth integer
retrieve string[] | string
sftp_list object
14 nested properties
host string required
username string required
password string
port integer
Default: 22
files_only boolean
Default: true
dirs_only boolean
Default: false
recursive boolean
Default: false
get_size boolean
Default: true
private_key string
private_key_pass string
dirs string[] | string
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
host_key object
2 nested properties
key_type string required
Values: "ssh-rsa" "ssh-ed25519"
public_key string required
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
2 nested properties
server object | object required
list string required
from_emby object
6 nested properties
server object | object required
list string
types string[] | string
watched boolean
favorite boolean
sort string | object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
5 nested properties
list string required
One of: enum enum, variant
user_id string
pattern=^ur\d{7,9}$
force_language string
Default: "en-us"
type string[] | string | string
strip_dates boolean
Default: false
status boolean
ombi_list object
One of: variant, variant
10 nested properties
url string required
type string required
Values: "shows" "seasons" "episodes" "movies"
api_key string
username string
password string
status string
Default: "approved"
Values: "approved" "requested" "denied" "all"
hide_available boolean
Default: true
on_remove string
Default: "deleted"
Values: "unavailable" "denied" "deleted"
include_year boolean
Default: false
include_ep_title boolean
Default: false
subtitle_list object
8 nested properties
list string required
languages string[]
minItems=1
check_subtitles boolean
Default: true
remove_after string
format=interval
path string
allow_dir boolean
Default: false
recursion_depth integer
Default: 1
min=1
force_file_existence boolean
Default: true
imdb_list object
4 nested properties
login string required
cookies string | string | object required
list string required
force_language string
Default: "en-us"
radarr_list object
9 nested properties
base_url string required
api_key string required
port number
Default: 80
only_monitored boolean
Default: true
include_data boolean
Default: false
only_use_cutoff_quality boolean
Default: false
monitored boolean
Default: true
profile_id integer
Default: 1
tags integer | string[]
plex_watchlist
5 nested properties
username string
password string
token string
type string
Values: "movie" "show"
filter string
Values: "available" "released"
thetvdb_list object
5 nested properties
username string required
account_id string required
api_key string required
strip_dates boolean
language string
sonarr_list object
17 nested properties
api_key string required
base_url string
Default: "http://localhost"
base_path string
Default: ""
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
include_data boolean
Default: false
search_missing_episodes boolean
Default: true
ignore_episodes_without_files boolean
Default: false
ignore_episodes_with_files boolean
Default: false
profile_id integer
Default: 1
language_id integer
Default: 1
season_folder boolean
Default: false
monitored boolean
Default: true
root_folder_path string
series_type string
Default: "standard"
Values: "standard" "daily" "anime"
tags string[]
yaml_list string | object
couchpotato_list object
4 nested properties
base_url string required
api_key string required
port number
Default: 80
include_data boolean
Default: false
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
3 nested properties
lf_session string
prefilter boolean
site_urls string | array
format=url
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
plugins object
--try-regexp
rtorrent object
17 nested properties
uri string required
username string
password string
digest_auth boolean
Default: false
start boolean
Default: true
mkdir boolean
Default: true
action string
Default: "add"
Values: "update" "delete" "add" "purge"
message string
priority string
path string
custom1 string
custom2 string
custom3 string
custom4 string
custom5 string
fast_resume boolean
Default: false
custom_fields Record<string, string>
from_rtorrent object
7 nested properties
uri string required
username string
password string
digest_auth boolean
Default: false
view string
Default: "main"
fields string[] | string
custom_fields string[]
nzbget object
4 nested properties
url string required
category string
Default: ""
priority integer
Default: 0
top boolean
Default: false
aria2 object
12 nested properties
path string required
server string
Default: "localhost"
port integer
Default: 6800
secret string
Default: ""
username string
Default: ""
password string
Default: ""
scheme string
Default: "http"
rpc_mode string
Default: "xml"
Values: "xml" "json"
rpc_path string
Default: "rpc"
filename string
add_extension string | boolean
Default: "no"
options Record<string, string | number | boolean>
transmission boolean | object
from_transmission boolean | object
clean_transmission boolean | object
pyload object
13 nested properties
username string required
password string required
api string
folder string
package string
package_password string
queue boolean
parse_url boolean
multiple_hoster boolean
hoster string[] | string
preferred_hoster_only boolean
handle_no_url_as_failure boolean
enabled boolean
qbittorrent boolean | object
from_qbittorrent object
6 nested properties
username string required
password string required
host string required
port integer required
category string
completed boolean
from_deluge boolean | object
deluge boolean | object
change_warn
api_bluray
best_quality object
4 nested properties
identified_by string
Default: "auto"
on_best string
Default: "do_nothing"
Values: "accept" "reject" "do_nothing"
on_lower string
Default: "reject"
Values: "accept" "reject" "do_nothing"
single_best boolean
Default: true
content_filter object
8 nested properties
min_files integer
max_files integer
require string | string[] | object
require_all string | string[] | object
reject string | string[] | object
require_mainfile boolean
Default: false
strict boolean
Default: false
regexp_mode boolean
Default: false
timeframe object
5 nested properties
target string required
format=quality_requirements
wait string required
format=interval
identified_by string
Default: "auto"
on_waiting string
Default: "reject"
Values: "accept" "reject" "do_nothing"
on_reached string
Default: "do_nothing"
Values: "accept" "reject" "do_nothing"
magnets boolean
age object
3 nested properties
field string required
action string required
Values: "accept" "reject"
age string required
format=interval
exists_series string[] | string | object
thetvdb object
16 nested properties
min_series_rating number
min_episode_rating number
min_episode_air_year integer
max_episode_air_year integer
min_episode_runtime number
max_episode_runtime number
reject_content_rating string[]
accept_content_rating string[]
accept_network string[]
reject_network string[]
reject_genres string[]
reject_status string[]
accept_actors string[]
reject_actors string[]
accept_directors string[]
reject_directors string[]
delay string
format=interval
require_field string[] | string
rottentomatoes object
14 nested properties
min_year integer
max_year integer
min_critics_score number
min_audience_score number
min_average_score number
min_critics_rating enum
Values: "rotten" "fresh" "certified fresh"
min_audience_rating enum
Values: "spilled" "upright"
reject_genres string[]
reject_actors string[]
accept_actors string[]
reject_directors string[]
accept_directors string[]
reject_mpaa_ratings string[]
accept_mpaa_ratings string[]
proper_movies boolean | string
only_new boolean
quality string[] | string
exists string[] | string
crossmatch object
6 nested properties
fields string[] required
action enum required
Values: "accept" "reject"
from plugins?phase=input[] required
exact boolean
Default: true
all_fields boolean
Default: false
case_sensitive boolean
Default: true
upgrade object
6 nested properties
identified_by string
tracking boolean
target string
format=quality_requirements
on_lower string
Values: "accept" "reject" "do_nothing"
timeframe string
format=interval
propers boolean
accept_all boolean

Accepts all entries

content_size object
3 nested properties
min number | string
format=size
max number | string
format=size
strict boolean
Default: true
duplicates object
2 nested properties
field string required
action enum required
Values: "accept" "reject"
abort_if_exists object
2 nested properties
regexp string required
format=regex
field string required
limit_new integer
min=1
exists_movie string[] | string | object
unique object
2 nested properties
field string[] | string required
action enum
Values: "accept" "reject"
regexp object
6 nested properties
accept_excluding string | object[]
reject_excluding string | object[]
rest string
Values: "accept" "reject"
from string[] | string
include string[] | string
proxy string | object
version_checker
form object
5 nested properties
url string required
format=url
username string required
password string required
userfield string
passfield string
free_space number | object
sequence plugins[]
verbose
interval string
format=interval
cookies string | object
template template[] | boolean
details
no_entries_ok boolean
disable string[] | string
domain_delay Record<string, string>
entry_operations
run_task object
2 nested properties
task string[] | string required
when string[] | string
digest string | object
from_digest object
4 nested properties
list string required
limit integer
expire string | boolean
Default: true
restore_state boolean
Default: false
spy_headers boolean
pathscrub string
Values: "windows" "linux" "mac"
max_reruns integer
verify_ssl_certificates boolean
manual boolean

Prevents this task from running unless it is explicitly specified with --tasks, or in a schedule

disable_phases string[]
abort
log_filter array
minItems=1
rerun integer
sleep object | integer
priority integer
delete boolean | object
copy boolean | object
move boolean | object
sns object
6 nested properties
sns_topic_arn string required
aws_region string required
sns_notification_template string
Default: "{"entry": {"title": "{{title}}", "url": "{{url}}", "original_url": "{{original_url}}", "series": "{{series_name}}", "series_id": "{{series_id}}"}, "task": "{{task}}"}"
aws_access_key_id string
aws_secret_access_key string
profile_name string
exec string[] | string | object
mock_output boolean
make_rss string | object
rtorrent_magnet string
format=path
symlink object | string
make_html object
2 nested properties
file string required
template string
subliminal object
8 nested properties
languages string[] required
minItems=1
alternatives string[]
exact_match boolean
Default: true
providers string[]
single boolean
Default: true
directory string
hearing_impaired boolean
Default: false
authentication object
9 nested properties
addic7ed object
gestdown object
napiprojekt object
opensubtitles object
opensubtitlescom object
opensubtitlescomvip object
opensubtitlesvip object
podnapisi object
tvsubtitles object
download_auth array
minItems=1
periscope object
4 nested properties
languages string[]
minItems=1
alternatives string[]
overwrite boolean
Default: false
subexts string[]
Default:
[
  "srt",
  "stp",
  "sub",
  "stl",
  "ssa"
]
dump boolean
sabnzbd object
8 nested properties
key string required
url string required
format=url
category string
script string
pp string
priority integer
password string
username string
dump_config
subtitles object
4 nested properties
languages string[]
Default:
[
  "eng"
]
min_sub_rating number
Default: 0.0
match_limit number
Default: 0.8
output string
format=path
utorrent object
4 nested properties
url string required
format=url
username string required
password string required
path string
download object | string | boolean
urlfix boolean
pogcal_acquired object
2 nested properties
username string required
password string required
kodi_library object
7 nested properties
action string required
Values: "clean" "scan"
category string required
Values: "audio" "video"
url string required
format=url
port integer
Default: 8080
username string
password string
only_on_accepted boolean
Default: true
myepisodes object
2 nested properties
username string required
password string required
metainfo_media_id boolean
rottentomatoes_lookup boolean | string
metainfo_movie boolean
assume_quality string | object
nfo_lookup boolean
check_subtitles boolean
metainfo_quality boolean
bluray_lookup boolean
metainfo_content_size boolean
Default: false
metainfo_task boolean
nzb_size
sort_by_weight object[]
minItems=2
path_by_space object
4 nested properties
select string required
Values: "most_free" "most_used" "most_free_percent" "most_used_percent"
paths string[] | string required
to_field string
Default: "path"
within string | string
plugin_priority Record<string, integer>
path_by_ext object
set object
sort_by string | object[] | string | object
reorder_quality Record<string, object>
headers Record<string, string>
regex_extract object
3 nested properties
prefix string
field string
regex string[] | string
extension string | number
manipulate object[]
medusa object
6 nested properties
base_url string required
format=uri
username string required
password string required
port number
Default: 8081
only_monitored boolean
Default: false
include_ended boolean
Default: false
twitterfeed object
7 nested properties
account string required
consumer_key string required
consumer_secret string required
access_token_key string required
access_token_secret string required
all_entries boolean
Default: true
tweets number
Default: 50
tail object
4 nested properties
file string required
format=file
entry object required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
next_sonarr_episodes object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
page_size number
Default: 50
torznab object
5 nested properties
url string required
format=url
apikey string
categories integer[]
Default:
[]
searcher string
Default: "search"
Values: "movie" "tv" "tvsearch" "search"
timeout string
format=interval
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
5 nested properties
user_id integer required
pattern=^\d{1,6}$
type string
Default: "movies"
Values: "shows" "movies" "ovas"
mode string
Default: "all"
Values: "all" "undefined" "watch" "get" "blacklist" "buddy"
pass string
strip_dates boolean
Default: false
gazelle object
5 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
gazellemusic object
19 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
redacted object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "concert recording" "dj mix"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
notwhatcd object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray" "Unknown"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "dj mix" "concert recording"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
from_telegram object
5 nested properties
token string required
types string[] | string
whitelist object | object | object[]
minItems=1
only_new boolean
Default: true
entry Record<string, string>
2 nested properties
url string
format=regex
title string
format=regex
filmweb_watchlist object
4 nested properties
login string required

Can be username or email address

password string required
type string
Default: "movies"
Values: "shows" "movies"
min_star integer

Items will be processed with at least this level of "How much I want to see"

Default: 0
Any of: variant, variant
12 nested properties
url string required
Any of: variant, variant
username string
password string
title string
link string[] | string
silent boolean
Default: false
ascii boolean
Default: false
escape boolean
Default: false
filename boolean
group_links boolean
Default: false
all_entries boolean
Default: true
other_fields string | object[]
rlslog string
format=url
text object
4 nested properties
url string | string required
entry Record<string, string> required
2 nested properties
url string required
format=regex
title string required
format=regex
encoding string
format Record<string, string>
pogcal object
2 nested properties
username string required
password string required
sickbeard object
6 nested properties
base_url string required
api_key string required
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: false
include_data boolean
Default: false
generate integer
kitsu object
One of: variant, variant
6 nested properties
username string
user_id string
lists string[] | string
type string[] | string
latest boolean
Default: false
status string
Values: "airing" "finished"
csv object
2 nested properties
url string required
format=url
values Record<string, integer> required
sceper string
format=url
plex object
14 nested properties
section string | integer required
server string
Default: "127.0.0.1"
port integer
Default: 32400
username string
password string
token string
selection string
Default: "all"
lowercase_title boolean
Default: false
strip_non_alpha boolean
Default: true
strip_year boolean
Default: true
strip_parens boolean
Default: false
original_filename boolean
Default: false
unwatched_only boolean
Default: false
fetch string
Default: "file"
Values: "file" "art" "cover" "thumb" "season_cover"
json object
3 nested properties
file string required
format=file
encoding string
field_map Record<string, string>
html string | object
apple_trailers object | string
from_piratebay object
5 nested properties
list string required
Default: "top"
Values: "top" "top48h" "recent"
url string
Default: "https://apibay.org"
format=url
category string | integer
query string
rank string
Default: "all"
Values: "all" "user" "member" "trusted" "vip" "helper" "moderator" "supermod"
regexp_parse object
4 nested properties
source string | string required
keys Record<string, object> required
encoding string
sections object[]
letterboxd object
4 nested properties
username string required
list string required
sort_by string
Default: "default"
Values: "default" "added" "length-ascending" "length-descending" "name" "popularity" "rating-ascending" "rating-descending" "release-ascending" "release-descending"
max_results integer
parameterize object
2 nested properties
plugin object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
using object
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
anilist string | object
myepisodes_list object
4 nested properties
username string required
password string required
strip_dates boolean
Default: false
include_ignored boolean
Default: false
betaseries_list object
4 nested properties
username string required
password string required
api_key string required
members string[]
rottentomatoes_list object
3 nested properties
dvds enum[]
movies enum[]
api_key string
my_anime_list object
4 nested properties
username string required
status string[] | string
Default: "all"
airing_status string[] | string
Default: "all"
type string[] | string
Default: "all"
npo_watchlist object
5 nested properties
email string required
password string required
remove_accepted boolean
Default: false
max_episode_age_days integer
Default: -1
download_premium boolean
Default: false
limit object
2 nested properties
amount integer required
min=-1
from required
All of: plugins?phase=input object, variant
discover object
5 nested properties
what array required
from array required
interval string
Default: "5 hours"
format=interval
release_estimations string | object
limit integer
min=1
backlog string
format=interval
history boolean
archive boolean | string[]
flexget_archive boolean | string[]
pending_approval boolean
private_torrents boolean
add_trackers string[]
remove_trackers string[]
modify_trackers object[]
magnet_btih boolean
torrent
torrent_size
torrent_scrub boolean | string | string[]
torrent_match object
2 nested properties
what array required
max_size_difference string
Default: "0%"
format=percent
torrent_files
torrent_alive boolean | integer | object
convert_magnet boolean | object
tmdb_lookup boolean | object
api_tmdb
parsing object
2 nested properties
movie string
Values: "guessit" "internal"
series string
Values: "guessit" "internal"
api_trakt
trakt_lookup object | boolean
trakt_list object
Any of: variant, variant, variant
6 nested properties
list string required
username string
account string
type string
Default: "auto"
Values: "shows" "seasons" "episodes" "movies" "auto"
strip_dates boolean
Default: false
language string
minLength=2maxLength=2
trakt_calendar object
5 nested properties
type string required
Values: "shows" "episodes"
start_day integer
Default: 0
days integer
Default: 7
account string
strip_dates boolean
Default: false
next_trakt_episodes object
Any of: variant, variant
6 nested properties
list string required
username string
account string
position string
Default: "next"
Values: "last" "next"
context string
Default: "watched"
Values: "watched" "collected" "aired"
strip_dates boolean
Default: false
thetvdb_lookup boolean | object
decompress boolean | object
archives boolean | object
urlrewriting
disable_urlrewriters string[]
urlrewrite Record<string, object>
urlrewrite_search array
notification_framework
notify object
3 nested properties
entries object
5 nested properties
via array required
title string
Default: "{{ title }}"
message string
Default: "{% if series_name is defined %}{{ tvdb_series_name|d(series_name) }} {{series_id}} {{tvdb_ep_name|d()}}{% elif imdb_name is defined %}{{imdb_name}} {{imdb_year}}{% elif title is defined %}{{ title }}{% endif %}"
template string
what string[] | string
task object
5 nested properties
via array required
title string
Default: "{% if not task.failed and not task.accepted %} Task {{task.name}} did not produce any entries.{% else %} [FlexGet] {{task.name}}:{% if task.failed %} {{task.failed|length}} failed entries.{% endif %}{% if task.accepted %} {{task.accepted|length}} new entries downloaded.{% endif %}{% endif %}"
message string
template string
Default: "default.template"
always_send boolean
Default: false
abort object
3 nested properties
via array required
title string
Default: "Task {{ task.name }} has aborted!"
message string
Default: "Reason: {{ task.abort_reason }}"
seen boolean | string | object
seen_info_hash boolean | string
seen_movies string | object
list_add array
list_match object
4 nested properties
from array
action string
Default: "accept"
Values: "accept" "reject"
remove_on_match boolean
Default: true
single_match boolean
Default: true
list_clear object
2 nested properties
what array required
phase string
Default: "start"
Values: "prepare" "start" "input" "metainfo" "filter" "urlrewrite" "download" "modify" "output" "learn" "exit"
list_remove array
api_tvmaze
tvmaze_lookup boolean
ftp_list object
10 nested properties
username string required
host string required
password string
port integer
ssl boolean
encoding string
dirs string[] | string
recursion boolean
recursion_depth integer
retrieve string[] | string
sftp_list object
14 nested properties
host string required
username string required
password string
port integer
Default: 22
files_only boolean
Default: true
dirs_only boolean
Default: false
recursive boolean
Default: false
get_size boolean
Default: true
private_key string
private_key_pass string
dirs string[] | string
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
host_key object
2 nested properties
key_type string required
Values: "ssh-rsa" "ssh-ed25519"
public_key string required
sftp_download object
5 nested properties
to string required
format=path
recursive boolean
Default: true
delete_origin boolean
Default: false
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
sftp_upload object
11 nested properties
host string required
username string required
password string
port integer
Default: 22
private_key string
private_key_pass string
to string
delete_origin boolean
Default: false
host_key object
2 nested properties
key_type string required
Values: "ssh-rsa" "ssh-ed25519"
public_key string required
socket_timeout_sec integer
Default: 15
connection_tries integer
Default: 3
ftp_download object
4 nested properties
use-ssl boolean
Default: false
ftp_tmp_path string
format=path
delete_origin boolean
Default: false
download_empty_dirs boolean
Default: false
next_series_episodes boolean | object
series Record<string, string | number | object[]>
1 nested properties
settings Record<string, object>
series_db
all_series boolean | object
gen_series_data object
configure_series object
2 nested properties
from object required
88 nested properties
from_rtorrent object
from_transmission boolean | object
from_qbittorrent object
from_deluge boolean | object
delay string
format=interval
sequence plugins[]
details
entry_operations
from_digest object
rerun integer
sleep object | integer
exec string[] | string | object
urlfix boolean
medusa object
twitterfeed object
tail object
next_sonarr_episodes object
filesystem string[] | string | object
from_task string
inputs array
anidb_list object
gazelle object
gazellemusic object
redacted object
notwhatcd object
from_telegram object
filmweb_watchlist object
Any of: variant, variant
rlslog string
format=url
text object
pogcal object
sickbeard object
generate integer
kitsu object
One of: variant, variant
csv object
sceper string
format=url
plex object
json object
html string | object
apple_trailers object | string
from_piratebay object
regexp_parse object
letterboxd object
parameterize object
anilist string | object
myepisodes_list object
betaseries_list object
rottentomatoes_list object
my_anime_list object
npo_watchlist object
limit object
discover object
backlog string
format=interval
pending_approval boolean
trakt_list object
Any of: variant, variant, variant
trakt_calendar object
next_trakt_episodes object
Any of: variant, variant
list_clear object
ftp_list object
sftp_list object
next_series_episodes boolean | object
gen_series_data object
next_series_seasons boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
from_emby object
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
status boolean
ombi_list object
One of: variant, variant
subtitle_list object
imdb_list object
radarr_list object
plex_watchlist
thetvdb_list object
sonarr_list object
yaml_list string | object
couchpotato_list object
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
eztv boolean
horriblesubs boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
settings object
26 nested properties
path string
set object
alternate_name string[] | string
name_regexp string[] | string
ep_regexp string[] | string
date_regexp string[] | string
sequence_regexp string[] | string
id_regexp string[] | string
date_yearfirst boolean
date_dayfirst boolean
quality string
format=quality_requirements
qualities string[]
timeframe string
format=interval
upgrade boolean
target string
format=quality_requirements
specials boolean
propers boolean | string
format=interval
identified_by string
Values: "ep" "date" "sequence" "id" "auto"
exact boolean
begin string | integer
format=episode_or_season_id
from_group string[] | string
parse_only boolean
special_ids string[] | string
prefer_specials boolean
assume_special boolean
season_packs boolean | integer | string | object
metainfo_series boolean
series_premiere boolean | object
set_series_begin boolean
next_series_seasons boolean | object
est_series_internal
series_remove boolean | object
retry_failed boolean | object
remember_rejected
emby_list object
2 nested properties
server object | object required
list string required
from_emby object
6 nested properties
server object | object required
list string
types string[] | string
watched boolean
favorite boolean
sort string | object
emby_lookup object | object
emby_refresh object
2 nested properties
server object | object required
when string[] | string
scan_imdb boolean
imdb object
17 nested properties
min_year integer
max_year integer
min_votes integer
min_meta_score integer
min_score number
accept_genres string[]
reject_genres string[]
reject_languages string[]
accept_languages string[]
reject_actors string[]
accept_actors string[]
reject_directors string[]
accept_directors string[]
reject_writers string[]
accept_writers string[]
reject_mpaa_ratings string[]
accept_mpaa_ratings string[]
from_imdb string[] | string | object
imdb_watchlist object
Any of: variant, variant
5 nested properties
list string required
One of: enum enum, variant
user_id string
pattern=^ur\d{7,9}$
force_language string
Default: "en-us"
type string[] | string | string
strip_dates boolean
Default: false
imdb_lookup boolean
status boolean
estimate_release
est_released_movies
est_series_tvmaze
est_movies_bluray
ombi_list object
One of: variant, variant
10 nested properties
url string required
type string required
Values: "shows" "seasons" "episodes" "movies"
api_key string
username string
password string
status string
Default: "approved"
Values: "approved" "requested" "denied" "all"
hide_available boolean
Default: true
on_remove string
Default: "deleted"
Values: "unavailable" "denied" "deleted"
include_year boolean
Default: false
include_ep_title boolean
Default: false
subtitle_list object
8 nested properties
list string required
languages string[]
minItems=1
check_subtitles boolean
Default: true
remove_after string
format=interval
path string
allow_dir boolean
Default: false
recursion_depth integer
Default: 1
min=1
force_file_existence boolean
Default: true
imdb_list object
4 nested properties
login string required
cookies string | string | object required
list string required
force_language string
Default: "en-us"
radarr_list object
9 nested properties
base_url string required
api_key string required
port number
Default: 80
only_monitored boolean
Default: true
include_data boolean
Default: false
only_use_cutoff_quality boolean
Default: false
monitored boolean
Default: true
profile_id integer
Default: 1
tags integer | string[]
plex_watchlist
5 nested properties
username string
password string
token string
type string
Values: "movie" "show"
filter string
Values: "available" "released"
thetvdb_list object
5 nested properties
username string required
account_id string required
api_key string required
strip_dates boolean
language string
sonarr_list object
17 nested properties
api_key string required
base_url string
Default: "http://localhost"
base_path string
Default: ""
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
include_data boolean
Default: false
search_missing_episodes boolean
Default: true
ignore_episodes_without_files boolean
Default: false
ignore_episodes_with_files boolean
Default: false
profile_id integer
Default: 1
language_id integer
Default: 1
season_folder boolean
Default: false
monitored boolean
Default: true
root_folder_path string
series_type string
Default: "standard"
Values: "standard" "daily" "anime"
tags string[]
yaml_list string | object
couchpotato_list object
4 nested properties
base_url string required
api_key string required
port number
Default: 80
include_data boolean
Default: false
entry_list string
regexp_list string
movie_list string | object
pending_list string | object
xmpp object
3 nested properties
sender string required
password string required
recipients string[] | string required
ifttt object
2 nested properties
event string required
keys string[] | string required
telegram object
6 nested properties
bot_token string required
recipients object | object | object | object[] required
minItems=1
parse_mode string
Values: "html" "markdown" "markdown_legacy"
disable_previews boolean
Default: false
socks_proxy string
images string[]
bark object
11 nested properties
server string required
device_key string required
level string
Values: "active" "timeSensitive" "passive"
badge integer
automatically_copy boolean
copy string
sound string
icon string
group string
is_archive boolean
url string
toast boolean | object
pushbullet object
One of: variant, variant, variant, variant
6 nested properties
api_key string[] | string required
device string[] | string
email string[] | string
url string
channel string
file_template string
ms_teams object
3 nested properties
web_hook_url string required
title string
theme_color string
sms_ru object
2 nested properties
phone_number string required
password string required
pushover object
11 nested properties
user_key string[] | string required
api_key string
Default: "aPwSHwkLcNaavShxktBpgJH4bRWc3m"
device string[] | string
priority number | string
url string
url_title string
sound string
retry integer
min=30
expire integer
max=86400
callback string
html boolean
matrix object
All of: variant, variant
8 nested properties
server string required
token string
user string
password string
device_name string
room_id string
room_address string
images string[]
notifymyandroid object
6 nested properties
api_key string[] | string required
application string
Default: "FlexGet"
priority integer
min=-2max=2
developer_key string
url string
html boolean
email object
10 nested properties
to string[] | string required
from string
Default: "[email protected]"
format=email
autofrom boolean
Default: false
smtp_host string
Default: "localhost"
smtp_port integer
Default: 25
smtp_username string
smtp_password string
smtp_tls boolean
Default: false
smtp_ssl boolean
Default: false
html boolean
Default: false
slack object
All of: variant
9 nested properties
web_hook_url string required
format=uri
username string
Default: "Flexget"
icon_url string
format=uri
icon_emoji string
channel string
unfurl_links boolean
message string
attachments object[]
blocks object[]
minItems=1maxItems=50
cronitor object | string
pushsafer object
16 nested properties
private_key string[] | string required
url string
url_title string
device string
icon integer
Default: 1
min=1max=181
iconcolor string
sound integer
min=0max=62
vibration integer
Default: 0
min=0max=3
timetolive integer
min=0max=43200
priority integer
min=-2max=2
retry integer
min=60max=10800
expire integer
min=60max=10800
confirm integer
min=10max=10800
answer integer
min=0max=1
answeroptions string
answerforce integer
min=0max=1
prowl object
5 nested properties
api_key string[] | string required
application string
Default: "FlexGet"
priority integer
min=-2max=2
url string
provider_key string
ntfysh object
7 nested properties
url required
Default: "https://ntfy.sh/"
format=url
topic string required
priority integer
Default: 3
delay string
tags string
username string
password string
pushalot object
8 nested properties
api_key string[] | string required
url string
url_title string
important boolean
Default: false
silent boolean
Default: false
image string
source string
Default: "FlexGet"
timetolive integer
min=0max=43200
rapidpush object
5 nested properties
api_key string[] | string required
category string
Default: "Flexget"
group string
channel string
priority integer
min=0max=6
gotify object
4 nested properties
url required
format=url
token string required
priority integer
Default: 4
content_type string
Default: "text/plain"
Values: "text/plain" "text/markdown"
join object
8 nested properties
api_key string required
group string
Values: "all" "android" "chrome" "windows10" "phone" "tablet" "pc"
device string[] | string
device_name string[] | string
url string
icon string
sms_number string
priority integer
min=-2max=2
mqtt object
12 nested properties
topic string required
broker_address string required
broker_port integer
Default: 1883
broker_timeout integer
Default: 30
broker_transport string
Default: "tcp"
Values: "tcp" "websockets"
broker_protocol string
Default: "MQTTv311"
Values: "MQTTv31" "MQTTv311"
username string
password string
encrypted_communication boolean
Default: false
certificates object
5 nested properties
broker_ca_cert string
client_cert string
client_key string
validate_broker_cert boolean
Default: true
tls_version string
Values: "tlsv1.2" "tlsv1.1" "tlsv1" ""
qos integer
Default: 0
min=0max=2
retain boolean
Default: false
discord object
5 nested properties
web_hook_url string required
format=uri
username string
Default: "Flexget"
avatar_url string
format=uri
silent boolean
Default: false
embeds object[]
eztv boolean
3 nested properties
lf_session string
prefilter boolean
site_urls string | array
format=url
ncore object
5 nested properties
username string required
password string required
category string[]
Default:
[]
sort_by string
Default: "default"
Values: "default" "date" "size" "seeds" "leechers" "downloads"
sort_reverse boolean
Default: false
cinemageddon
iptorrents object
5 nested properties
rss_key string required
uid integer | string required
password string required
category integer | string[] | integer | string
free boolean
Default: false
alpharatio object
7 nested properties
username string required
password string required
category string[] | string
order_by string
Default: "time"
Values: "seeders" "leechers" "time" "size" "year" "snatched"
order_desc boolean
Default: true
scene boolean
leechstatus string
Default: "normal"
Values: "normal" "freeleech" "neutral leech" "either"
serienjunkies object
2 nested properties
language string
Values: "german" "foreign" "subtitle" "dual"
hoster string
Values: "ul" "cz" "so" "all"
horriblesubs boolean
rutracker boolean
rutracker_auth object
2 nested properties
username string
password string
wordpress_auth object
3 nested properties
url string required
One of: variant
username string
Default: ""
password string
Default: ""
bakabt
solidtorrents boolean | object
btn string | object
shortened
cpasbien object
1 nested properties
category string required
Values: "films" "series" "musique" "films-french" "720p" "series-francaise" "films-dvdrip" "all" "films-vostfr" "1080p" "series-vostfr" "ebook"
ettv
koreus
anirena
search_rss rss
torrentleech object
4 nested properties
rss_key string required
username string required
password string required
category integer | string[] | integer | string
allyoulike
torrentz object | enum
newznab object
One of: variant, variant
4 nested properties
category string required
Values: "movie" "tvsearch" "tv" "music" "book" "all"
url string
format=url
website string
format=url
apikey string
redirect_url
morethantv object
7 nested properties
username string required
password string required
category string[] | string
order_by string
Default: "time"
Values: "seeders" "leechers" "time"
order_way string
Default: "desc"
Values: "desc" "asc"
tags string[] | string
all_tags boolean
Default: true
passthepopcorn object
9 nested properties
apiuser string required
apikey string required
passkey string required
tags string[] | string
order_by string
Default: "Time added"
Values: "Relevance" "Time added" "Time w/o reseed" "First time added" "Year" "Title" "Size" "Snatched" "Seeders" "Leechers" "Runtime" "IMDb rating" "IMDb vote count" "PTP rating" "PTP vote count" "MC rating" "RT rating" "Bookmark count"
order_desc boolean
Default: true
freeleech boolean
release_type string
Values: "non-scene" "scene" "golden popcorn"
grouping boolean
Default: false
piratebay boolean | object
rlsbb object
3 nested properties
filehosters_re array
Default:
[]
link_text_re array
Default:
[
  "UPLOADGiG",
  "NiTROFLARE",
  "RAPiDGATOR"
]
parse_comments boolean
Default: false
google_cse
google
1337x boolean | object
nyaa string | object
argenteam object
1 nested properties
force_subtitles boolean
Default: true
yts boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
limetorrents boolean | object
hebits object
8 nested properties
userid number required
session string required
category string
Values: "movies" "tv" "theater" "software" "games" "music" "books" "movies_packs" "porno" "other"
free boolean
double boolean
triple boolean
order_by string
Default: "time"
Values: "time" "year" "size" "snatched" "seeders" "leechers" "random"
order_desc boolean
Default: true
torrent_cache
awesomehd object | string
filelist_api object
7 nested properties
username string required
passkey string required
category string[] | string
internal boolean
Default: false
moderated boolean
Default: false
freeleech boolean
Default: false
doubleup boolean
Default: false
torrentday object
5 nested properties
rss_key string required
uid integer | string required
passkey string required
cfduid string required
category integer | string[] | integer | string
parser_guessit
parser_internal
plugins?interface=search object
torznab object
5 nested properties
url string required
format=url
apikey string
categories integer[]
Default:
[]
searcher string
Default: "search"
Values: "movie" "tv" "tvsearch" "search"
timeout string
format=interval
gazelle object
5 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
gazellemusic object
19 nested properties
base_url string required
username string required
password string required
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
redacted object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "concert recording" "dj mix"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
notwhatcd object
19 nested properties
username string required
password string required
base_url string
max_pages integer
search string
artist string
album string
year string | integer
tags string[] | string
tag_type string
Values: "any" "all"
encoding string
Values: "192" "APS (VBR)" "V2 (VBR)" "V1 (VBR)" "256" "APX (VBR)" "V0 (VBR)" "q8.x (VBR)" "320" "Lossless" "24bit Lossless" "Other"
format string
Values: "MP3" "FLAC" "Ogg Vorbis" "AAC" "AC3" "DTS"
media string
Values: "CD" "DVD" "Vinyl" "Soundboard" "SACD" "DAT" "Cassette" "WEB" "Blu-ray" "Unknown"
release_type string
Values: "album" "soundtrack" "EP" "anthology" "compilation" "single" "live album" "remix" "bootleg" "interview" "mixtape" "unknown" "demo" "dj mix" "concert recording"
log string | boolean
leech_type string
Values: "freeleech" "neutral" "either" "normal"
hascue boolean
scene boolean
vanityhouse boolean
flexget_archive boolean | string[]
from_emby object
6 nested properties
server object | object required
list string
types string[] | string
watched boolean
favorite boolean
sort string | object
entry_list string
eztv boolean
ncore object
5 nested properties
username string required
password string required
category string[]
Default:
[]
sort_by string
Default: "default"
Values: "default" "date" "size" "seeds" "leechers" "downloads"
sort_reverse boolean
Default: false
iptorrents object
5 nested properties
rss_key string required
uid integer | string required
password string required
category integer | string[] | integer | string
free boolean
Default: false
alpharatio object
7 nested properties
username string required
password string required
category string[] | string
order_by string
Default: "time"
Values: "seeders" "leechers" "time" "size" "year" "snatched"
order_desc boolean
Default: true
scene boolean
leechstatus string
Default: "normal"
Values: "normal" "freeleech" "neutral leech" "either"
horriblesubs boolean
solidtorrents boolean | object
btn string | object
cpasbien object
1 nested properties
category string required
Values: "films" "series" "musique" "films-french" "720p" "series-francaise" "films-dvdrip" "all" "films-vostfr" "1080p" "series-vostfr" "ebook"
search_rss rss
torrentleech object
4 nested properties
rss_key string required
username string required
password string required
category integer | string[] | integer | string
torrentz object | enum
newznab object
One of: variant, variant
4 nested properties
category string required
Values: "movie" "tvsearch" "tv" "music" "book" "all"
url string
format=url
website string
format=url
apikey string
morethantv object
7 nested properties
username string required
password string required
category string[] | string
order_by string
Default: "time"
Values: "seeders" "leechers" "time"
order_way string
Default: "desc"
Values: "desc" "asc"
tags string[] | string
all_tags boolean
Default: true
passthepopcorn object
9 nested properties
apiuser string required
apikey string required
passkey string required
tags string[] | string
order_by string
Default: "Time added"
Values: "Relevance" "Time added" "Time w/o reseed" "First time added" "Year" "Title" "Size" "Snatched" "Seeders" "Leechers" "Runtime" "IMDb rating" "IMDb vote count" "PTP rating" "PTP vote count" "MC rating" "RT rating" "Bookmark count"
order_desc boolean
Default: true
freeleech boolean
release_type string
Values: "non-scene" "scene" "golden popcorn"
grouping boolean
Default: false
piratebay boolean | object
1337x boolean | object
nyaa string | object
argenteam object
1 nested properties
force_subtitles boolean
Default: true
yts boolean
uindex string
Values: "movies" "tv" "game" "music" "app" "xxx" "anime" "other"
limetorrents boolean | object
hebits object
8 nested properties
userid number required
session string required
category string
Values: "movies" "tv" "theater" "software" "games" "music" "books" "movies_packs" "porno" "other"
free boolean
double boolean
triple boolean
order_by string
Default: "time"
Values: "time" "year" "size" "snatched" "seeders" "leechers" "random"
order_desc boolean
Default: true
awesomehd object | string
filelist_api object
7 nested properties
username string required
passkey string required
category string[] | string
internal boolean
Default: false
moderated boolean
Default: false
freeleech boolean
Default: false
doubleup boolean
Default: false
torrentday object
5 nested properties
rss_key string required
uid integer | string required
passkey string required
cfduid string required
category integer | string[] | integer | string
plugins?interface=notifiers object
xmpp object
3 nested properties
sender string required
password string required
recipients string[] | string required
ifttt object
2 nested properties
event string required
keys string[] | string required
telegram object
6 nested properties
bot_token string required
recipients object | object | object | object[] required
minItems=1
parse_mode string
Values: "html" "markdown" "markdown_legacy"
disable_previews boolean
Default: false
socks_proxy string
images string[]
bark object
11 nested properties
server string required
device_key string required
level string
Values: "active" "timeSensitive" "passive"
badge integer
automatically_copy boolean
copy string
sound string
icon string
group string
is_archive boolean
url string
toast boolean | object
pushbullet object
One of: variant, variant, variant, variant
6 nested properties
api_key string[] | string required
device string[] | string
email string[] | string
url string
channel string
file_template string
ms_teams object
3 nested properties
web_hook_url string required
title string
theme_color string
sms_ru object
2 nested properties
phone_number string required
password string required
pushover object
11 nested properties
user_key string[] | string required
api_key string
Default: "aPwSHwkLcNaavShxktBpgJH4bRWc3m"
device string[] | string
priority number | string
url string
url_title string
sound string
retry integer
min=30
expire integer
max=86400
callback string
html boolean
matrix object
All of: variant, variant
8 nested properties
server string required
token string
user string
password string
device_name string
room_id string
room_address string
images string[]
notifymyandroid object
6 nested properties
api_key string[] | string required
application string
Default: "FlexGet"
priority integer
min=-2max=2
developer_key string
url string
html boolean
email object
10 nested properties
to string[] | string required
from string
Default: "[email protected]"
format=email
autofrom boolean
Default: false
smtp_host string
Default: "localhost"
smtp_port integer
Default: 25
smtp_username string
smtp_password string
smtp_tls boolean
Default: false
smtp_ssl boolean
Default: false
html boolean
Default: false
slack object
All of: variant
9 nested properties
web_hook_url string required
format=uri
username string
Default: "Flexget"
icon_url string
format=uri
icon_emoji string
channel string
unfurl_links boolean
message string
attachments object[]
blocks object[]
minItems=1maxItems=50
pushsafer object
16 nested properties
private_key string[] | string required
url string
url_title string
device string
icon integer
Default: 1
min=1max=181
iconcolor string
sound integer
min=0max=62
vibration integer
Default: 0
min=0max=3
timetolive integer
min=0max=43200
priority integer
min=-2max=2
retry integer
min=60max=10800
expire integer
min=60max=10800
confirm integer
min=10max=10800
answer integer
min=0max=1
answeroptions string
answerforce integer
min=0max=1
prowl object
5 nested properties
api_key string[] | string required
application string
Default: "FlexGet"
priority integer
min=-2max=2
url string
provider_key string
ntfysh object
7 nested properties
url required
Default: "https://ntfy.sh/"
format=url
topic string required
priority integer
Default: 3
delay string
tags string
username string
password string
pushalot object
8 nested properties
api_key string[] | string required
url string
url_title string
important boolean
Default: false
silent boolean
Default: false
image string
source string
Default: "FlexGet"
timetolive integer
min=0max=43200
rapidpush object
5 nested properties
api_key string[] | string required
category string
Default: "Flexget"
group string
channel string
priority integer
min=0max=6
gotify object
4 nested properties
url required
format=url
token string required
priority integer
Default: 4
content_type string
Default: "text/plain"
Values: "text/plain" "text/markdown"
join object
8 nested properties
api_key string required
group string
Values: "all" "android" "chrome" "windows10" "phone" "tablet" "pc"
device string[] | string
device_name string[] | string
url string
icon string
sms_number string
priority integer
min=-2max=2
mqtt object
12 nested properties
topic string required
broker_address string required
broker_port integer
Default: 1883
broker_timeout integer
Default: 30
broker_transport string
Default: "tcp"
Values: "tcp" "websockets"
broker_protocol string
Default: "MQTTv311"
Values: "MQTTv31" "MQTTv311"
username string
password string
encrypted_communication boolean
Default: false
certificates object
5 nested properties
broker_ca_cert string
client_cert string
client_key string
validate_broker_cert boolean
Default: true
tls_version string
Values: "tlsv1.2" "tlsv1.1" "tlsv1" ""
qos integer
Default: 0
min=0max=2
retain boolean
Default: false
discord object
5 nested properties
web_hook_url string required
format=uri
username string
Default: "Flexget"
avatar_url string
format=uri
silent boolean
Default: false
embeds object[]
plugins?interface=list object
trakt_list object
Any of: variant, variant, variant
6 nested properties
list string required
username string
account string
type string
Default: "auto"
Values: "shows" "seasons" "episodes" "movies" "auto"
strip_dates boolean
Default: false
language string
minLength=2maxLength=2
emby_list object
2 nested properties
server object | object required
list string required
ombi_list object
One of: variant, variant
10 nested properties
url string required
type string required
Values: "shows" "seasons" "episodes" "movies"
api_key string
username string
password string
status string
Default: "approved"
Values: "approved" "requested" "denied" "all"
hide_available boolean
Default: true
on_remove string
Default: "deleted"
Values: "unavailable" "denied" "deleted"
include_year boolean
Default: false
include_ep_title boolean
Default: false
subtitle_list object
8 nested properties
list string required
languages string[]
minItems=1
check_subtitles boolean
Default: true
remove_after string
format=interval
path string
allow_dir boolean
Default: false
recursion_depth integer
Default: 1
min=1
force_file_existence boolean
Default: true
imdb_list object
4 nested properties
login string required
cookies string | string | object required
list string required
force_language string
Default: "en-us"
radarr_list object
9 nested properties
base_url string required
api_key string required
port number
Default: 80
only_monitored boolean
Default: true
include_data boolean
Default: false
only_use_cutoff_quality boolean
Default: false
monitored boolean
Default: true
profile_id integer
Default: 1
tags integer | string[]
plex_watchlist
5 nested properties
username string
password string
token string
type string
Values: "movie" "show"
filter string
Values: "available" "released"
thetvdb_list object
5 nested properties
username string required
account_id string required
api_key string required
strip_dates boolean
language string
sonarr_list object
17 nested properties
api_key string required
base_url string
Default: "http://localhost"
base_path string
Default: ""
port number
Default: 80
include_ended boolean
Default: true
only_monitored boolean
Default: true
include_data boolean
Default: false
search_missing_episodes boolean
Default: true
ignore_episodes_without_files boolean
Default: false
ignore_episodes_with_files boolean
Default: false
profile_id integer
Default: 1
language_id integer
Default: 1
season_folder boolean
Default: false
monitored boolean
Default: true
root_folder_path string
series_type string
Default: "standard"
Values: "standard" "daily" "anime"
tags string[]
yaml_list string | object
couchpotato_list object
4 nested properties
base_url string required
api_key string required
port number
Default: 80
include_data boolean
Default: false
entry_list string
regexp_list string
movie_list string | object
pending_list string | object