Add configuration requirements for various analyzers

2026-04-24 21:47:48 +02:00 · 2022-05-24 12:29:14 +00:00
parent 3e6dfcfaca
commit 92dee14ee8
6 changed files with 122 additions and 0 deletions
@@ -0,0 +1,20 @@
+# Urlscan
+
+## Description
+Submit a URL to Urlscan for analysis.
+
+## Configuration Requirements
+
+``api_key`` - API key used for communication with the Virustotal API
+``enabled`` - Determines whether or not the analyzer is enabled. Defaults to ``False``
+``visibility`` - Determines whether or not scan results are visibile publicly. Defaults to ``public``
+``timeout`` - Time to wait for scan results. Defaults to ``180``s
+
+This value should be set in the pillar, like so:
+
+```
+sensoroni:
+  analyzers:
+    urlscan:
+      api_key: $yourapikey
+```