From a62a2e0e98b0e1e199f43b7267075741e5c7d144 Mon Sep 17 00:00:00 2001 From: Martin Polehla Date: Mon, 25 Sep 2023 22:27:38 +0300 Subject: [PATCH] /rest/db/localignored API documentation --- rest/db-localignored-get.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 rest/db-localignored-get.rst diff --git a/rest/db-localignored-get.rst b/rest/db-localignored-get.rst new file mode 100644 index 00000000..da6f71f5 --- /dev/null +++ b/rest/db-localignored-get.rst @@ -0,0 +1,32 @@ +GET /rest/db/localignored +========================= + +.. versionadded:: 0.14.55 + +Takes one mandatory parameter, ``folder``, and returns the list of files which +are ignored in a receive-only folder and exists locally. + +The results can be paginated using the :ref:`common pagination parameters +`. + +.. code-block:: json + + { + "files": [ + { + "flags": "0755", + "sequence": 6, + "modified": "2015-04-20T23:06:12+09:00", + "name": "ls", + "size": 34640, + "version": [ + "5157751870738175669:1" + ] + } + ], + "page": 1, + "perpage": 100 + } + +.. note:: This is an expensive call, increasing CPU and RAM usage on the device. + Use sparingly.