crowdsec/docs/cscli/cscli_api.md

cscli api

Crowdsec API interaction

Synopsis

Allow to register your machine into crowdsec API to send and receive alert.

Examples

cscli api register      # Register to Crowdsec API
cscli api pull          # Pull malevolant IPs from Crowdsec API
cscli api reset         # Reset your machines credentials
cscli api enroll        # Enroll your machine to the user account you created on Crowdsec backend
cscli api credentials   # Display your API credentials

Options

  -h, --help   help for api

Options inherited from parent commands

  -c, --config string   path to crowdsec config file (default "/etc/crowdsec/config/default.yaml")
      --debug           Set logging to debug.
      --error           Set logging to error.
      --info            Set logging to info.
  -o, --output string   Output format : human, json, raw. (default "human")
      --warning         Set logging to warning.

SEE ALSO

• cscli - cscli allows you to manage crowdsec
• cscli api credentials - Display api credentials
• cscli api enroll - Associate your machine to an existing crowdsec user
• cscli api pull - Pull crowdsec API TopX
• cscli api register - Register on Crowdsec API
• cscli api reset - Reset password on CrowdSec API