Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation update for #2455 #2460

Merged
merged 2 commits into from
Feb 6, 2024
Merged

Documentation update for #2455 #2460

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b694889
Documentation update for #2455
elsif2 Feb 5, 2024
d8dee57
Added suggested example from Sebix.
elsif2 Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/user/bots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -930,8 +930,7 @@ oldest files available!).

The resulting reports contain the following special field:

- `extra.file_name`: The name of the downloaded file, with fixed filename extension. The API returns file names with the
extension `.csv`, although the files are JSON, not CSV. Therefore, for clarity and better error detection in the parser, the file name in `extra.file_name` uses `.json` as extension.
- `extra.file_name`: The name of the downloaded file, with fixed filename extension.

**Module:** `intelmq.bots.collectors.shadowserver.collector_reports_api`

Expand All @@ -951,7 +950,7 @@ The resulting reports contain the following special field:

**`types`**

(optional, string/array of strings) An array of strings (or a list of comma-separated values) with the names of report types you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined'). The possible report types are equivalent to the file names given in the section Supported Reports of the [Shadowserver parser](#intelmq.bots.parsers.shadowserver.parser).
(optional, string/array of strings) An array of strings (or a list of comma-separated values) with the names of report types you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined'). The possible report types are equivalent to the file names defined the the schema. Please see the Supported Reports of the [Shadowserver parser](#intelmq.bots.parsers.shadowserver.parser) for details.

**Sample configuration**

Expand Down Expand Up @@ -2154,7 +2153,7 @@ correct mapping of the columns:

**`feedname`**

(optional, string) Name of the Shadowserver report, see list below for possible values.
(optional, string) Name of the Shadowserver report. The value for each report type can be found in the schema `feed_name` field.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example using curl https://interchange.shadowserver.org/intelmq/v1/schema | jq .[].feed_name?


**`overwrite`**

Expand Down
Loading