Introduction
The central API is the service where the local API pushes signal meta-data and from where it receives the community blocklists.
Data exchanged with the central API#
Signal meta-data#
info
This information is only going to be pushed when a scenario is coming from the hub and is unmodified. Custom scenarios, tainted scenarios and manual decisions are not pushed
When crowdsec blocks an attack, unless you opt-out of it, crowdsec is going to push "signal meta-data". Those meta-data are :
- The name of the scenario that was triggered
- The hash & version of the scenario that was triggered
- The timestamp of the decision
- Your machine_id
- The offending IP (along with its geoloc info when available)
Scenario list#
The community blocklist matches the scenarios deployed on the crowdsec instance. For this reason, crowdsec provides the list of enabled scenarios (from the hub only) during the login process.
Console metrics#
With the upcoming release of the console and for genreal health monitoring of the project, crowdsec reports the following data to the central API :
- name and versions of the deployed bouncers
- name and versions of the crowdsec agents registered to the local API