Web UI API - Forums - µTorrent - The Lightweight and Efficient BitTorrent Client

Actions:

Torrent Adding

http://[iP]:[PORT]/gui/?action=add-url&s=[TORRENT URL]

This action adds a torrent job from the given URL. For servers that require cookies, cookies can be sent with the :COOKIE: method (see here). The string must be URL-encoded.

http://[iP]:[PORT]/gui/?action=add-file

This action is different from the other actions in that it uses HTTP POST instead of HTTP GET to submit data to µTorrent. The HTTP form must use an enctype of "multipart/form-data" and have an input field of type "file" with name "torrent_file" that stores the local path to the file to upload to µTorrent.

Basic Actions

http://[iP]:[PORT]/gui/?action=start&hash=[TORRENT HASH]

This action tells µTorrent to start the specified torrent job(s). Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=stop&hash=[TORRENT HASH]

This action tells µTorrent to stop the specified torrent job(s). Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=pause&hash=[TORRENT HASH]

This action tells µTorrent to pause the specified torrent job(s). Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=unpause&hash=[TORRENT HASH]

This action tells µTorrent to unpause the specified torrent job(s). Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=forcestart&hash=[TORRENT HASH]

This action tells µTorrent to force the specified torrent job(s) to start. Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=recheck&hash=[TORRENT HASH]

This action tells µTorrent to recheck the torrent contents for the specified torrent job(s). Multiple hashes may be specified to act on multiple torrent jobs.

http://[iP]:[PORT]/gui/?action=remove&hash=[TORRENT HASH]

This action removes the specified torrent job(s) from the torrent jobs list. Multiple hashes may be specified to act on multiple torrent jobs. This action currently ignores the "Move to trash if possible" option in µTorrent 1.7.x, though that'll change in µTorrent 1.8 (post build 9272).

http://[iP]:[PORT]/gui/?action=removedata&hash=[TORRENT HASH]

This action removes the specified torrent job(s) from the torrent jobs list and removes the corresponding torrent contents (data) from disk. Multiple hashes may be specified to act on multiple torrent jobs. This action currently ignores the "Move to trash if possible" option in µTorrent 1.7.x, though that'll change in µTorrent 1.8 (post build 9272).

http://[iP]:[PORT]/gui/?action=setprio&hash=[TORRENT HASH]&p=[PRIORITY]&f=[FILE INDEX]

This action sets the priority for the specified file(s) in the torrent job. The possible priority levels are the values returned by "getfiles". A file is specified using the zero-based index of the file in the inside the list returned by "getfiles". Only one priority level may be specified on each call to this action, but multiple files may be specified.

Queue Management

http://[iP]:[PORT]/gui/?action=queuebottom&hash=[TORRENT HASH]

This action tells µTorrent to move the specified torrent to the bottom of the queue.

http://[iP]:[PORT]/gui/?action=queuedown&hash=[TORRENT HASH]

This action tells µTorrent to move the specified torrent one position down the queue.

http://[iP]:[PORT]/gui/?action=queuetop&hash=[TORRENT HASH]

This action tells µTorrent to move the specified torrent to the top of the queue.

http://[iP]:[PORT]/gui/?action=queueup&hash=[TORRENT HASH]

This action tells µTorrent to move the specified torrent one position up the queue.

Quote
Remarks:
Multiple hashes may be strung together to change torrent queue order in batches, but the order in which the queue order changes are applied is the order in which the hashes are listed as GET parameters. As an example, see the following:
/gui/?action=queueup&hash=[TORRENT B QUEUED AT 2]&hash=[TORRENT A QUEUED AT 1]
This request will effectively result in nothing having happened. Why? Because the backend will first push TORRENT B up the queue to 1st, which pushes TORRENT A down the queue to 2nd. Then it will apply queueup on TORRENT A afterwards, which pushes it back up from 2nd to 1st (leaving TORRENT B back at 2nd).
All the other requests behave similarly as well. Essentially, in most situations, if torrent hashes are going to be batched up into one request, clients should sorted the list in queue order.
- queueup and queuebottom should be sent hash lists sorted in ascending queue order
- queuedown and queuetop should be sent hash lists sorted in descending queue order