Add missing parameter to WebUI-API section 'Set torrent share limit'

Also organized parameters into a table for clarity and made descriptions more concise.
Anton Kävenheim 2024-05-12 12:54:25 +02:00 committed by GitHub
parent 3ff8257630
commit 1e7d37e6f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

@ -2196,12 +2196,17 @@ Cookie: SID=your_sid
Content-Type: application/x-www-form-urlencoded Content-Type: application/x-www-form-urlencoded
Content-Length: length Content-Length: length
hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&ratioLimit=1.0&seedingTimeLimit=60 hashes=8c212779b4abde7c6bc608063a0d008b7e40ce32|284b83c9c7935002391129fd97f43db5d7cc2ba0&ratioLimit=1.0&seedingTimeLimit=60&inactiveSeedingTimeLimit=-2
``` ```
`hashes` can contain multiple hashes separated by `|` or set to `all` **Parameters:**
`ratioLimit` is the max ratio the torrent should be seeded until. `-2` means the global limit should be used, `-1` means no limit.
`seedingTimeLimit` is the max amount of time (minutes) the torrent should be seeded. `-2` means the global limit should be used, `-1` means no limit. Property | Type | Description
------------------------------|---------|------------
`hashes` | integer | The hashes of the torrents for which you want to set the share limits. Multiple hashes need to be seperated by `\|` or set to `all`.
`ratioLimit` | integer | The maximum seeding ratio for the torrent. `-2` means the global limit should be used, `-1` means no limit.
`seedingTimeLimit` | integer | The maximum seeding time (minutes) for the torrent. `-2` means the global limit should be used, `-1` means no limit.
`inactiveSeedingTimeLimit` | integer | The maximum amount of time (minutes) the torrent is allowed to seed while being inactive. `-2` means the global limit should be used, `-1` means no limit.
**Returns:** **Returns:**