From fb889c6a20368de0233ab428202d43354eeb68dd Mon Sep 17 00:00:00 2001 From: V Date: Sat, 6 Jul 2024 17:09:50 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33feac8..fd3ee15 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Available API are ``` POST /scanstream - scan stream -POST -d '{"bucketname": $S3_BUCKET "key": $S3_OBJECT }' /s3/scanfile - scan s3 file +POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile - scan a file which is in s3 ( in scanning bucket ) GET /ruleset/ - list all loaded ruleset From 2fa8203ddde5eafc9e2de826a3a011bd9b8de383 Mon Sep 17 00:00:00 2001 From: V Date: Sat, 6 Jul 2024 17:10:58 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd3ee15..e616822 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ Available API are ``` POST /scanstream - scan stream -POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile - scan a file which is in s3 ( in scanning bucket ) +POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, + "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile - scan a file which is in s3 ( in scanning bucket ) GET /ruleset/ - list all loaded ruleset From b9cc234be39bd771e21bb5da9edd326ffad189ed Mon Sep 17 00:00:00 2001 From: V Date: Sat, 6 Jul 2024 17:14:01 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e616822..cc02642 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,26 @@ Multi Cloud antivirus scanning API based on CLAMAV and YARA for AWS S3, AZURE Bl ## API Available API are ``` -POST /scanstream - scan stream +# Scan stream +POST /scanstream -d @file_to_scan -POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, - "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile - scan a file which is in s3 ( in scanning bucket ) +# scan a file which is in s3 ( in scanning bucket ) +POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile -GET /ruleset/ - list all loaded ruleset +# list all loaded ruleset +GET /ruleset/ -GET /ruleset/{ruleset} - list all rules from a loaded rule +# list all rules from a loaded rule +GET /ruleset/{ruleset} -GET /metrics - get metrics -GET /health - get health info -GET / - get index +# get metrics +GET /metrics + +# get health info +GET /health + +#get index +GET / ```