mirror of
https://github.com/transmission/transmission
synced 2024-12-25 01:03:01 +00:00
(trunk doc) tweak the RPC spec as suggested by chorlya
This commit is contained in:
parent
236f8ad2ff
commit
6fa7197105
1 changed files with 12 additions and 4 deletions
|
@ -48,10 +48,16 @@
|
||||||
2.3. Transport Mechanism
|
2.3. Transport Mechanism
|
||||||
|
|
||||||
HTTP POSTing a JSON-encoded request is the preferred way of communicating
|
HTTP POSTing a JSON-encoded request is the preferred way of communicating
|
||||||
with a Transmission RPC server; however, a simple notation also exists
|
with a Transmission RPC server. The current Transmission implementation
|
||||||
for sending requests in the query portion of a URL.
|
has the default URL as http://host:9091/transmission/rpc. Clients
|
||||||
|
may use this as a default, but should allow the URL to be reconfigured,
|
||||||
|
since the port and path may be changed to allow mapping and/or multiple
|
||||||
|
daemons to run on a single server.
|
||||||
|
|
||||||
|
In addition to POSTing, there's also a simple notation for sending
|
||||||
|
requests in the query portion of a URL. This is not as robust, but can
|
||||||
|
be useful for debugging and simple tasks. The notation works as follows:
|
||||||
|
|
||||||
The URL notation works as follows:
|
|
||||||
(1) Any key not "tag" or "method" is treated as an argument.
|
(1) Any key not "tag" or "method" is treated as an argument.
|
||||||
(2) The "arguments" key isn't needed, since data isn't nested.
|
(2) The "arguments" key isn't needed, since data isn't nested.
|
||||||
(3) If the value in a key/value pair can be parsed as a number, then it is.
|
(3) If the value in a key/value pair can be parsed as a number, then it is.
|
||||||
|
@ -61,6 +67,7 @@
|
||||||
Examples:
|
Examples:
|
||||||
?method=torrent-start&ids=1,2
|
?method=torrent-start&ids=1,2
|
||||||
?method=session-set&speed-limit-down=50&speed-limit-down-enabled=1
|
?method=session-set&speed-limit-down=50&speed-limit-down-enabled=1
|
||||||
|
|
||||||
|
|
||||||
3. Torrent Requests
|
3. Torrent Requests
|
||||||
|
|
||||||
|
@ -244,7 +251,8 @@
|
||||||
|
|
||||||
{
|
{
|
||||||
"arguments": {
|
"arguments": {
|
||||||
"fields": [ "id", "name", "totalSize" ]
|
"fields": [ "id", "name", "totalSize" ],
|
||||||
|
"ids": [ 7, 10 ]
|
||||||
},
|
},
|
||||||
"method": "torrent-get",
|
"method": "torrent-get",
|
||||||
"tag": 39693
|
"tag": 39693
|
||||||
|
|
Loading…
Reference in a new issue