Jackett/docs/schema-definitions-searchpathblock.md

SearchPathBlock Schema

Cardigann#/definitions/SearchPathBlock

One search request. All matching paths are requested and their results combined.

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

SearchPathBlock Type

object (SearchPathBlock)

SearchPathBlock Properties

Property	Type	Required	Nullable	Defined by
path	string	Required	cannot be null	Cardigann indexer definition
method	string	Optional	cannot be null	Cardigann indexer definition
followredirect	boolean	Optional	cannot be null	Cardigann indexer definition
categories	array	Optional	cannot be null	Cardigann indexer definition
inputs	object	Optional	cannot be null	Cardigann indexer definition
inheritinputs	boolean	Optional	cannot be null	Cardigann indexer definition
queryseparator	string	Optional	cannot be null	Cardigann indexer definition
response	object	Optional	cannot be null	Cardigann indexer definition

path

Search URL path. Templates and conditionals are allowed.

path

• is required

• Type: string (Path)

• cannot be null

• defined in: Cardigann indexer definition

path Type

string (Path)

method

HTTP method: get or post. Templates are allowed. Default: get.

method

• is optional

• Type: string (Method)

• cannot be null

• defined in: Cardigann indexer definition

method Type

string (Method)

followredirect

Follow redirects on search requests. If true, set a selector in login.test. Default: false.

followredirect

• is optional

• Type: boolean (Follow redirect)

• cannot be null

• defined in: Cardigann indexer definition

followredirect Type

boolean (Follow redirect)

categories

Only use this path if the search includes at least one of these tracker categories. A leading "!" inverts the match.

categories

• is optional

• Type: an array of merged types (Tracker category)

• cannot be null

• defined in: Cardigann indexer definition

categories Type

an array of merged types (Tracker category)

inputs

Extra HTTP arguments for this path only.

inputs

• is optional

• Type: object (Inputs (SearchPathBlock))

• cannot be null

• defined in: Cardigann indexer definition

inputs Type

object (Inputs (SearchPathBlock))

inheritinputs

Use the search-level inputs as the base for this path's inputs. Default: true.

inheritinputs

• is optional

• Type: boolean (Inherit inputs)

• cannot be null

• defined in: Cardigann indexer definition

inheritinputs Type

boolean (Inherit inputs)

queryseparator

Query string separator. Default: &.

queryseparator

• is optional

• Type: string (Query separator)

• cannot be null

• defined in: Cardigann indexer definition

queryseparator Type

string (Query separator)

response

Response type for non-HTML search results. Omit for HTML, which is the default.

response

• is optional

• Type: object (ResponseBlock)

• cannot be null

• defined in: Cardigann indexer definition

response Type

object (ResponseBlock)