Actions - WebAPI

Last Updated: Jun 02, 2014 12:00PM PDT

This section contains a list of all the other possible actions supported by the API.

HTTP://[IP]:[PORT]/GUI/?ACTION=START&HASH=[TORRENT HASH]

This action tells BitTorrent 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 BitTorrent 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 BitTorrent to pause 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 BitTorrent 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=UNPAUSE&HASH=[TORRENT HASH]

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

HTTP://[IP]:[PORT]/GUI/?ACTION=RECHECK&HASH=[TORRENT HASH]

This action tells BitTorrent 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 respects the option "Move to trash if possible".

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 respects the option "Move to trash if possible".

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.

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 BitTorrent. 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 BitTorrent.

Are you a Pro customer? Contact our support team