/
PY
pyload
/
pyLoad API Documentation - OpenAPI
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 9m ago · Updated 4w ago
View markdown
pyload
pyLoad API Documentation - OpenAPI
post
Restart pyload core.
00b0770e3fa6
latest
OpenAPI 3.1.1
2026-07-17
84
14
84.8 KB
pyLoad REST
84
post
Adds files to specific package.
post
Adds a package, with links to desired destination.
post
creates new user login.
post
changes password for specific user.
post
Checks online status, retrieves names, and will add packages. Because of these packages are not added immediately, only for internal use.
get
Check authentication and returns details.
post
Initiates online status check.
post
checks online status of urls and a submitted container file.
post
Gets urls and returns plugin name mapped to list of matched urls.
post
Deletes several file entries from pyload.
post
Deletes all finished files and completely finished packages.
post
Deletes packages and containing links.
get
Available free space at download directory in bytes.
post
Generates and add packages.
post
Parses links, generates packages names from urls.
get
returns all known user and info.
get
similar to `check_auth` but returns UserData type.
get
All available account types.
get
Get information about all entered accounts.
get
Returns all information stored by addon plugins. Values are always strings.
get
returns all known user and info.
get
No documentation available
get
Returns a captcha task.
get
Get information about captcha task.
get
same as `get_queue` for collector.
get
same as `get_queue_data` for collector.
get
Retrieves complete config of core.
get
Retrieves complete config in dict format, not for RPC.
get
Retrieve config value.
get
Lists occurred events, may be affected to changes in the future.
get
Get complete information about a specific file.
get
Information about file order within package.
get
Returns information stored by a specific plugin.
get
Returns most recent log entries.
get
Returns complete information about package, and included files.
get
Returns information about package, without detailed information about containing files.
get
Returns information about package order.
get
Retrieves complete config for all plugins.
get
Plugin config as dict, not for RPC.
get
Returns info about queue and packages, **not** about files, see `get_queue_data` or `get_package_data` instead.
get
Return complete data about everything in queue, this is very expensive use it sparely. See `get_queue` for alternative.
get
pyLoad Core version.
get
A dict of available services, these can be defined by addon plugins.
get
similar to `check_auth` but returns UserData pe.
get
No documentation available
get
Checks whether a service is available.
post
checks if the user is authorized for specific method.
get
Indicates whether a captcha task is available.
get
Checks if pyload will start new downloads according to time in config.
get
Checks if pyload will try to make a reconnect.
post
Clean way to quit pyLoad.
post
Move multiple files to another package.
post
Set a new package location.
post
Gives a new position to a file within its package.
post
Gives a package a new position.
post
Parses html content or any arbitrary text for links and returns result of `check_urls`
post
Pause server: It won't start any new downloads, but nothing gets aborted.
get
Polls the result available for ResultID.
post
Moves package from Queue to Collector.
post
Moves package from Collector to Queue.
post
Probes online status of all files in a package, also a default action when package is added.
post
Remove account from pyload.
post
deletes a user login.
post
Restart pyload core.
post
Restarts all failed failes.
post
Resets file status, so it will be downloaded again.
post
Restarts a package, resets every containing files.
post
Calls a service (a method in addon plugin).
post
Set result for a captcha task.
post
Set new config value.
post
Allows to modify several package attributes.
post
Renames a package.
post
No documentation available
get
Status of all currently running downloads.
get
Some general information about the current status of pyLoad.
post
Aborts all running downloads.
post
Aborts specific downloads.
post
Toggle pause state.
post
Toggle proxy activation.
post
Toggle reconnect activation.
post
Unpause server: New Downloads will be started.
post
Changes pw/options for specific account.
post
Uploads and adds a container file to pyLoad.
get
Check if a user actually exists in the database.
pyLoad REST
Restart pyload core.
Restart pyload core.
post
/api/restart
Response
No response