From 9b4df9e516099fcf828556b5e461b43c1afa6d0b Mon Sep 17 00:00:00 2001 From: Eric Leblond Date: Sat, 2 Nov 2024 11:19:48 +0100 Subject: [PATCH] docs: document datajson unix-socket commands Ticket: #7372 --- doc/userguide/rules/datasets.rst | 38 ++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/doc/userguide/rules/datasets.rst b/doc/userguide/rules/datasets.rst index c84cc03cbd06..df610f9cbe21 100644 --- a/doc/userguide/rules/datasets.rst +++ b/doc/userguide/rules/datasets.rst @@ -263,6 +263,44 @@ Syntax:: dataset-dump +datajson-add +~~~~~~~~~~~~ + +Unix Socket command to add data to a set. On success, the addition becomes +active instantly. + +Syntax:: + + datajson-add + +set name + Name of an already defined dataset +type + Data type: string, md5, sha256, ipv4, ip +data + Data to add in serialized form (base64 for string, hex notation for md5/sha256, string representation for ipv4/ip) + +Example adding 'google.com' to set 'myset':: + + datajson-add myset string Z29vZ2xlLmNvbQ== {"city":"Mountain View"} + +datajson-remove +~~~~~~~~~~~~~~~ + +Unix Socket command to remove data from a set. On success, the removal becomes +active instantly. + +Syntax:: + + datajson-remove + +set name + Name of an already defined dataset +type + Data type: string, md5, sha256, ipv4, ip +data + Data to remove in serialized form (base64 for string, hex notation for md5/sha256, string representation for ipv4/ip) + File formats ------------