Ignore:
Timestamp:
Feb 10, 2009, 6:19:43 PM (13 years ago)
Author:
charles
Message:

(1.5x doc) tweak the RPC spec as suggested by chorlya

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/1.5x/doc/rpc-spec.txt

    r7733 r7868  
    4949
    5050   HTTP POSTing a JSON-encoded request is the preferred way of communicating
    51    with a Transmission RPC server; however, a simple notation also exists
    52    for sending requests in the query portion of a URL.
    53 
    54    The URL notation works as follows:
     51   with a Transmission RPC server.  The current Transmission implementation
     52   has the default URL as http://host:9091/transmission/rpc.  Clients
     53   may use this as a default, but should allow the URL to be reconfigured,
     54   since the port and path may be changed to allow mapping and/or multiple
     55   daemons to run on a single server.
     56
     57   In addition to POSTing, there's also a simple notation for sending
     58   requests in the query portion of a URL.  This is not as robust, but can
     59   be useful for debugging and simple tasks.  The notation works as follows:
     60
    5561   (1) Any key not "tag" or "method" is treated as an argument.
    5662   (2) The "arguments" key isn't needed, since data isn't nested.
     
    6268   ?method=torrent-start&ids=1,2
    6369   ?method=session-set&speed-limit-down=50&speed-limit-down-enabled=1
     70   
    6471
    65723.  Torrent Requests
     
    245252      {
    246253         "arguments": {
    247              "fields": [ "id", "name", "totalSize" ]
     254             "fields": [ "id", "name", "totalSize" ],
     255             "ids": [ 7, 10 ]
    248256         },
    249257         "method": "torrent-get",
     
    282290   -------------------+-------------------------------------------------
    283291   "download-dir"     | string      path to download the torrent to
    284    "filename"         | string      location of the .torrent file
     292   "filename"         | string      filename or URL of the .torrent file
    285293   "metainfo"         | string      base64-encoded .torrent content
    286294   "paused"           | 'boolean'   if true, don't start the torrent
     
    363371   "torrentCount"             | number
    364372   "uploadSpeed"              | number
     373   ---------------------------+-------------------------------+
     374   "cumulative-stats"         | object, containing:           |
     375                              +------------------+------------+
     376                              | uploadedBytes    | number     | tr_session_stats
     377                              | downloadedBytes  | number     | tr_session_stats
     378                              | filesAdded       | number     | tr_session_stats
     379                              | sessionCount     | number     | tr_session_stats
     380                              | secondsActive    | number     | tr_session_stats
     381   ---------------------------+-------------------------------+
     382   "current-stats"            | object, containing:           |
     383                              +------------------+------------+
     384                              | uploadedBytes    | number     | tr_session_stats
     385                              | downloadedBytes  | number     | tr_session_stats
     386                              | filesAdded       | number     | tr_session_stats
     387                              | sessionCount     | number     | tr_session_stats
     388                              | secondsActive    | number     | tr_session_stats
    365389   
    366390
     
    383407   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
    384408         |         |           | session-get    | new arg "rpc-version-minimum"
     409         |         |           | session-stats  | added "cumulative-stats"
     410         |         |           | session-stats  | added "current-stats"
    385411         |         |           | torrent-get    | new arg "downloadDir"
    386412   ------+---------+-----------+----------------+-------------------------------
Note: See TracChangeset for help on using the changeset viewer.