docs: add curl examples
This commit is contained in:
parent
03cc1cadc8
commit
9c0cbd9e4f
|
@ -22,3 +22,34 @@ The payload expected for adding a torrent can be empty, flagging or unflagging a
|
|||
"is_flagged": false
|
||||
}
|
||||
```
|
||||
|
||||
## Examples
|
||||
Listing all tracked torrents
|
||||
```bash
|
||||
$ curl http://127.0.0.1:1212/t/?token=MyAccessToken
|
||||
[{"info_hash":"1234567890123456789012345678901234567890","is_flagged":true,"completed":0,"seeders":0,"leechers":0}]
|
||||
```
|
||||
|
||||
Getting information for a specific torrent
|
||||
```bash
|
||||
$ curl http://127.0.0.1:1212/t/1234567890123456789012345678901234567890?token=MyAccessToken
|
||||
{"info_hash":"1234567890123456789012345678901234567890","is_flagged":false,"completed":0,"seeders":0,"leechers":1,"peers":[[{"id":"2d7142343235302d3458295942396f5334af686b","client":"qBittorrent"},{"ip":"192.168.1.6:52391","uploaded":0,"downloaded":0,"left":0,"event":"Started","updated":672}]]}
|
||||
```
|
||||
|
||||
Adding a torrent (non-dynamic trackers) or Unflagging a torrent:
|
||||
```bash
|
||||
$ curl -X POST http://127.0.0.1:1212/t/1234567890123456789012345678901234567890?token=MyAccessToken -d "{\"is_flagged\": false}" -H "Content-Type: application/json"
|
||||
{"status":"ok"}
|
||||
```
|
||||
|
||||
Removing a torrent:
|
||||
```bash
|
||||
$ curl -X DELETE http://127.0.0.1:1212/t/1234567890123456789012345678901234567890?token=MyAccessToken
|
||||
{"status":"ok"}
|
||||
```
|
||||
|
||||
Flagging a torrent:
|
||||
```bash
|
||||
$ curl -X POST http://127.0.0.1:1212/t/1234567890123456789012345678901234567890?token=MyAccessToken -d "{\"is_flagged\": true}" -H "Content-Type: application/json"
|
||||
{"info_hash":"1234567890123456789012345678901234567890","is_flagged":true,"completed":0,"seeders":0,"leechers":0,"peers":[]}
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue