Jackett/docs/schema-definitions-modes.md

Modes Schema

Cardigann#/definitions/Modes

Torznab search modes and the query parameters the tracker supports for each. Most apps calling Jackett depend on these being correct.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	schema.json*

Modes Type

object (Modes)

Modes Properties

Property	Type	Required	Nullable	Defined by
search	array	Required	cannot be null	Cardigann indexer definition
tv-search	array	Optional	cannot be null	Cardigann indexer definition
movie-search	array	Optional	cannot be null	Cardigann indexer definition
music-search	array	Optional	cannot be null	Cardigann indexer definition
book-search	array	Optional	cannot be null	Cardigann indexer definition

search

Parameters for basic search. q is the minimum and is required.

search

• is required

• Type: string[] (Search parameter)

• cannot be null

• defined in: Cardigann indexer definition

search Type

string[] (Search parameter)

search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

tv-search

Parameters supported for TV search. Only list those the tracker can search with.

tv-search

• is optional

• Type: string[] (Search parameter)

• cannot be null

• defined in: Cardigann indexer definition

tv-search Type

string[] (Search parameter)

tv-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

movie-search

Parameters supported for movie search. Only list those the tracker can search with.

movie-search

• is optional

• Type: string[] (Search parameter)

• cannot be null

• defined in: Cardigann indexer definition

movie-search Type

string[] (Search parameter)

movie-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

music-search

Parameters supported for music search. Only list those the tracker can search with.

music-search

• is optional

• Type: string[] (Search parameter)

• cannot be null

• defined in: Cardigann indexer definition

music-search Type

string[] (Search parameter)

music-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.

book-search

Parameters supported for book search. Only list those the tracker can search with.

book-search

• is optional

• Type: string[] (Search parameter)

• cannot be null

• defined in: Cardigann indexer definition

book-search Type

string[] (Search parameter)

book-search Constraints

unique items: all items in this array must be unique. Duplicates are not allowed.