From 958e3e299ceed17e4f9a4ce867e3a4e9a1f2e19e Mon Sep 17 00:00:00 2001 From: Mike Tzou Date: Sat, 14 Oct 2017 16:29:26 +0800 Subject: [PATCH] Document getLog command --- WebUI-API-Documentation.md | 42 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/WebUI-API-Documentation.md b/WebUI-API-Documentation.md index 2ca4002..9ae69b4 100644 --- a/WebUI-API-Documentation.md +++ b/WebUI-API-Documentation.md @@ -19,6 +19,7 @@ 1. [Get global transfer info](#get-global-transfer-info) 1. [Get qBittorrent preferences](#get-qbittorrent-preferences) 1. [Get partial data](#get-partial-data) + 1. [Get log](#get-log) 1. [POST methods](#post-methods) 1. [Download torrent from URL](#download-torrent-from-url) 1. [Upload torrent from disk](#upload-torrent-from-disk) @@ -777,6 +778,47 @@ Property | Type | Description `queueing` | bool | Priority system usage flag `server_state` | object | Same as [global transfer info](#get-global-transfer-info) +### Get log ### + +```http +GET /query/getLog HTTP/1.1 +User-Agent: Fiddler +Host: 127.0.0.1 +Cookie: SID=your_sid +``` + +Params: + +Param | Type | Description +----------------|---------|------------ +`normal` | bool | Include normal messages (default: `true`) +`info` | bool | Include info messages (default: `true`) +`warning` | bool | Include warning messages (default: `true`) +`critical` | bool | Include critical messages (default: `true`) +`last_known_id` | integer | Exclude messages with "message id" <= `last_known_id` (default: `-1`) + +Example: +```http +/query/getLog?normal=true&info=true&warning=true&critical=true&last_known_id=-1 +``` + +Server will return the following reply (example): + +```http +HTTP/1.1 200 OK +content-type: application/json +content-length: length + +[{"id":0,"message":"qBittorrent v3.4.0 started","timestamp":1507969127860,"type":1},{"id":1,"message":"qBittorrent is trying to listen on any interface port: 19036","timestamp":1507969127869,"type":2},{"id":2,"message":"Peer ID: -qB3400-","timestamp":1507969127870,"type":1},{"id":3,"message":"HTTP User-Agent is 'qBittorrent/3.4.0'","timestamp":1507969127870,"type":1},{"id":4,"message":"DHT support [ON]","timestamp":1507969127871,"type":2},{"id":5,"message":"Local Peer Discovery support [ON]","timestamp":1507969127871,"type":2},{"id":6,"message":"PeX support [ON]","timestamp":1507969127871,"type":2},{"id":7,"message":"Anonymous mode [OFF]","timestamp":1507969127871,"type":2},{"id":8,"message":"Encryption support [ON]","timestamp":1507969127871,"type":2},{"id":9,"message":"Embedded Tracker [OFF]","timestamp":1507969127871,"type":2},{"id":10,"message":"UPnP / NAT-PMP support [ON]","timestamp":1507969127873,"type":2},{"id":11,"message":"Web UI: Now listening on port 8080","timestamp":1507969127883,"type":1},{"id":12,"message":"Options were saved successfully.","timestamp":1507969128055,"type":1},{"id":13,"message":"qBittorrent is successfully listening on interface :: port: TCP/19036","timestamp":1507969128270,"type":2},{"id":14,"message":"qBittorrent is successfully listening on interface 0.0.0.0 port: TCP/19036","timestamp":1507969128271,"type":2},{"id":15,"message":"qBittorrent is successfully listening on interface 0.0.0.0 port: UDP/19036","timestamp":1507969128272,"type":2}] +``` + +Property | Type | Description +------------|---------|------------ +`id` | integer | ID of the message +`message` | string | Text of the message +`timestamp` | integer | Milliseconds since epoch +`type` | integer | Type of the message: Log::NORMAL: `1`, Log::INFO: `2`, Log::WARNING: `4`, Log::CRITICAL: `8` + # POST methods # ### Download torrent from URL ###