The API for Zilean can be accessed at http://localhost:8181/scalar/v2 by default, where you can see more information on the endpoints outlined below.
Some endpoints can be disabled, so they do not get mapped by the Api, and then ultimately do not exist while Zilean is running. Refer to Configuration for more details on enabling/disabling endpoints.
Authentication
Some Api Endpoints require authenticated requests. To perform these, include the ApiKey in the headers:
Header Key: X-Api-Key
Header Value: <API_KEY>
This ApiKey is generated on first run of zilean, and stored in the settings file: settings.json
Full List of Endpoints
Blacklist Endpoints
Path
Description
Authenticated
/blacklist/add
Add a torrent to the blacklist.
Yes
/blacklist/remove
Remove a torrent from the blacklist.
Yes
Dmm Endpoints
Path
Description
Authenticated
/dmm/search
Search for content.
No
/dmm/filtered
Filter search results.
No
/dmm/on-demand-scrape
Ingest content on demand.
Yes
Imdb Endpoints
Path
Description
Authenticated
/imdb/search
Search for content.
No
Torznab Endpoints
Path
Description
Authenticated
/torznab/api
Search feeds using torznab parameters.
No
Torrents Endpoints
Path
Description
Authenticated
/torrents/all
Stream all torrents in the database.
Yes
/torrents/checkcached
Check if a hash, or collection of hashes, is cached.