# pyLoad pyLoad REST API

**Canonical:** https://apis.io/apis/pyload/pyload-pyload-rest-api/  
**Provider:** pyLoad — https://apis.io/providers/pyload/  
**Documentation:** https://github.com/pyload/pyload/wiki/API

pyLoad pyLoad REST API is published by [pyLoad](https://apis.io/providers/pyload/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include pyLoad REST. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The pyLoad REST API from pyLoad — 84 operation(s) for pyload rest.

## Operations (60 of 84)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/add_files` | Adds files to specific package |
| POST | `/api/add_package` | Adds a package, with links to desired destination |
| POST | `/api/add_user` | creates new user login |
| POST | `/api/change_password` | changes password for specific user |
| POST | `/api/check_and_add_packages` | Checks online status, retrieves names, and will add packages. |
| GET | `/api/check_auth` | Check authentication and returns details |
| POST | `/api/check_online_status` | Initiates online status check |
| POST | `/api/check_online_status_container` | checks online status of urls and a submitted container file |
| POST | `/api/check_urls` | Gets urls and returns plugin name mapped to list of matched urls |
| POST | `/api/delete_files` | Deletes several file entries from pyload |
| POST | `/api/delete_finished` | Deletes all finished files and completely finished packages |
| POST | `/api/delete_packages` | Deletes packages and containing links |
| GET | `/api/free_space` | Available free space at download directory in bytes |
| POST | `/api/generate_and_add_packages` | Generates and add packages |
| POST | `/api/generate_packages` | Parses links, generates packages names from urls |
| GET | `/api/getAllUserData` | returns all known user and info |
| GET | `/api/getUserData` | similar to `check_auth` but returns UserData type |
| GET | `/api/get_account_types` | All available account types |
| GET | `/api/get_accounts` | Get information about all entered accounts |
| GET | `/api/get_all_info` | Returns all information stored by addon plugins. Values are always strings |
| GET | `/api/get_all_userdata` | returns all known user and info |
| GET | `/api/get_cachedir` | No documentation available |
| GET | `/api/get_captcha_task` | Returns a captcha task |
| GET | `/api/get_captcha_task_status` | Get information about captcha task |
| GET | `/api/get_collector` | same as `get_queue` for collector |
| GET | `/api/get_collector_data` | same as `get_queue_data` for collector |
| GET | `/api/get_config` | Retrieves complete config of core |
| GET | `/api/get_config_dict` | Retrieves complete config in dict format, not for RPC |
| GET | `/api/get_config_value` | Retrieve config value |
| GET | `/api/get_events` | Lists occurred events, may be affected to changes in the future |
| GET | `/api/get_file_data` | Get complete information about a specific file |
| GET | `/api/get_file_order` | Information about file order within package |
| GET | `/api/get_info_by_plugin` | Returns information stored by a specific plugin |
| GET | `/api/get_log` | Returns most recent log entries |
| GET | `/api/get_package_data` | Returns complete information about package, and included files |
| GET | `/api/get_package_info` | Returns information about package, without detailed information about… |
| GET | `/api/get_package_order` | Returns information about package order |
| GET | `/api/get_plugin_config` | Retrieves complete config for all plugins |
| GET | `/api/get_plugin_config_dict` | Plugin config as dict, not for RPC |
| GET | `/api/get_queue` | Returns info about queue and packages, **not** about files, see… |
| GET | `/api/get_queue_data` | Return complete data about everything in queue, this is very expensive use it… |
| GET | `/api/get_server_version` | pyLoad Core version |
| GET | `/api/get_services` | A dict of available services, these can be defined by addon plugins |
| GET | `/api/get_userdata` | similar to `check_auth` but returns UserData pe |
| GET | `/api/get_userdir` | No documentation available |
| GET | `/api/has_service` | Checks whether a service is available |
| POST | `/api/is_authorized` | checks if the user is authorized for specific method |
| GET | `/api/is_captcha_waiting` | Indicates whether a captcha task is available |
| GET | `/api/is_time_download` | Checks if pyload will start new downloads according to time in config |
| GET | `/api/is_time_reconnect` | Checks if pyload will try to make a reconnect |
| POST | `/api/kill` | Clean way to quit pyLoad |
| POST | `/api/move_files` | Move multiple files to another package |
| POST | `/api/move_package` | Set a new package location |
| POST | `/api/order_file` | Gives a new position to a file within its package |
| POST | `/api/order_package` | Gives a package a new position |
| POST | `/api/parse_urls` | Parses html content or any arbitrary text for links and returns result of… |
| POST | `/api/pause_server` | Pause server: It won't start any new downloads, but nothing gets aborted |
| GET | `/api/poll_results` | Polls the result available for ResultID |
| POST | `/api/pull_from_queue` | Moves package from Queue to Collector |
| POST | `/api/push_to_queue` | Moves package from Collector to Queue |

…and 24 more operations. They are listed in full on the page.

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/pyload/openapi/pyload-pyload-rest-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-download-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-package-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-file-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-server-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-user-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/pyload/json-schema/pyload-account-info-schema.json
- **APIsJSON** — https://artifacts.apis.io/pyload/apis.yml

## Tags

pyLoad REST

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pyload/pyload-pyload-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pyload/.