/

/pyLoad API Documentation - OpenAPI

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 18m ago · Updated 1mo ago

Filter operations

pyLoad Authentication2

pyLoad REST84

postAdds files to specific package.
postAdds a package, with links to desired destination.
postcreates new user login.
postchanges password for specific user.
postChecks online status, retrieves names, and will add packages. Because of these packages are not added immediately, only for internal use.
postCheck authentication and returns details.
postInitiates online status check.
postchecks online status of urls and a submitted container file.
postGets urls and returns pluginname mapped to list of matched urls.
postDeletes several file entries from pyload.
getDeletes all finished files and completely finished packages.
postDeletes packages and containing links.
getAvailable free space at download directory in bytes.
postGenerates and add packages.
postParses links, generates packages names from urls.
getreturns all known user and info.
postsimilar to `check_auth` but returns UserData thrift type.
getAll available account types.
postGet information about all entered accounts.
getReturns all information stored by addon plugins. Values are always strings.
getreturns all known user and info.
getNo documentation available
postReturns a captcha task.
postGet information about captcha task.
getsame as `get_queue` for collector.
getsame as `get_queue_data` for collector.
getRetrieves complete config of core.
getRetrieves complete config in dict format, not for RPC.
postRetrieve config value.
postLists occurred events, may be affected to changes in the future.
postGet complete information about a specific file.
postInformation about file order within package.
postReturns information stored by a specific plugin.
postReturns most recent log entries.
postReturns complete information about package, and included files.
postReturns information about package, without detailed information about containing files.
postReturns information about package order.
getRetrieves complete config for all plugins.
getPlugin config as dict, not for RPC.
getReturns info about queue and packages, **not** about files, see `get_queue_data` or `get_package_data` instead.
getReturn complete data about everything in queue, this is very expensive use it sparely. See `get_queue` for alternative.
getpyLoad Core version.
getA dict of available services, these can be defined by addon plugins.
postsimilar to `check_auth` but returns UserData thrift type.
getNo documentation available
postChecks whether a service is available.
postchecks if the user is authorized for specific method.
getIndicates whether a captcha task is available.
getChecks if pyload will start new downloads according to time in config.
getChecks if pyload will try to make a reconnect.
getClean way to quit pyLoad.
postMove multiple files to another package.
postSet a new package location.
postGives a new position to a file within its package.
postGives a package a new position.
postParses html content or any arbitrary text for links and returns result of `check_urls`
getPause server: It won't start any new downloads, but nothing gets aborted.
postPolls the result available for ResultID.
postMoves package from Queue to Collector.
postMoves package from Collector to Queue.
postProbes online status of all files in a package, also a default action when package is added.
postRemove account from pyload.
postdeletes a user login.
getRestart pyload core.
getRestarts all failed failes.
postResets file status, so it will be downloaded again.
postRestarts a package, resets every containing files.
postCalls a service (a method in addon plugin).
postSet result for a captcha task.
postSet new config value.
postAllows to modify several package attributes.
postRenames a package.
postNo documentation available
getStatus of all currently running downloads.
getSome general information about the current status of pyLoad.
getAborts all running downloads.
postAborts specific downloads.
getToggle pause state.
getToggle proxy activation.
getToggle reconnect activation.
getUnpause server: New Downloads will be started.
postChanges pw/options for specific account.
postUploads and adds a container file to pyLoad.
postCheck if a user actually exists in the database.

pyLoad REST

Returns most recent log entries.

Returns most recent log entries.

post/api/get_log

Query parameters

offsetinteger

line offset

Response

List of log entries

string[] required

Changes