Skip to main content

Archiving a Security Engine

Archiving a Security Engine allows you to deactivate it without losing historical alerts. This can be helpful when an engine is no longer actively used but you still want to retain its historical context and alerts for future analysis.

In the case of Enterprise plans, an archived engine does not count as a used slot.

When archived, the Security Engine will:

  • Stop reporting new alerts.
  • Be un-enrolled from the CrowdSec Console.
  • Remain available for historical consultation. All previously generated alerts from this engine remain accessible from the Alerts page.

How to Archive a Security Engineโ€‹

Manually archiving a Security Engineโ€‹

1.Go to the Security Engines page

2.Click on the three-dot menu (โ‹ฎ) next to the Security Engine you wish to archive.

3.Select Archive Security Engine from the dropdown menu.

Archive Engine

4.Confirm the archival by clicking the Archive button in the confirmation dialog. The dialog clearly indicates that alerts will remain accessible even after archiving.

Archive modal

Auto-archiving of Security Enginesโ€‹

The CrowdSec Console also offers an auto-archiving feature based on inactivity. You can configure this policy from the Security Engines section in the console settings, where you can specify a duration of inactivity after which the engine is automatically archived.

This feature helps maintain an organized workspace by automatically managing Security Engines that have ceased generating alerts, ensuring your active view remains relevant and uncluttered. All auto-archived engines retain their historical alerts, accessible through the Alerts page.

settings auto archiving

Viewing Archived Security Enginesโ€‹

To see your archived Security Engines locate and check the option labeled Show only archived. Archived engines will appear in a greyed-out, read-only state.

info

the Console features will no longer be synchronized with archived Security Engines.

This means that blocklists, scenarios and remediation components counters will always be 0.

Show archived Engine

Restoring an Archived Security Engineโ€‹

If you wish to restore an archived Security Engine, simply re-enroll the Security Engine by executing the enrollment command again from your server.

warning

Add the --overwrite flag to the enrollment command in order to replace the current status in the Console.

Permanently Deleting an Archived Security Engineโ€‹

If you decide to completely remove an archived Security Engine:

  1. Make sure you have selected Show only archived.
  2. Click the trash icon (๐Ÿ—‘๏ธ) located in the top-right corner of the Security Engine card.
  3. Confirm deletion when prompted. This action will permanently remove all associated data and alerts.

Show archived Engine