CrowdSec-Manager Docs
Api

API Overview

General information about the CrowdSec Manager API

API Overview

CrowdSec Manager exposes a RESTful API for all its operations. The frontend communicates with the backend exclusively through this API.

Base URL

All API endpoints are prefixed with /api.

Example: http://localhost:8080/api/health/stack

Authentication

The API is protected by network configuration. Access is restricted to the local network or via the exposed port/reverse proxy. No token-based authentication is required.

Response Format

All responses use the same JSON envelope.

Success Response

{
  "success": true,
  "data": { ... }
}

Success with message

{
  "success": true,
  "message": "Operation completed"
}

Error Response

{
  "success": false,
  "error": "Error description"
}

Endpoint Reference

Health

MethodPathDescription
GET/api/health/stackStack service health
GET/api/health/crowdsecCrowdSec health
GET/api/health/completeFull diagnostics

IP

MethodPathDescription
GET/api/ip/publicGet public IP
GET/api/ip/blocked/:ipCheck if IP is blocked
GET/api/ip/security/:ipIP security lookup
POST/api/ip/unbanUnban an IP

Whitelist

MethodPathDescription
GET/api/whitelist/viewView current whitelist
POST/api/whitelist/currentWhitelist current IP
POST/api/whitelist/manualWhitelist manual IP
POST/api/whitelist/cidrWhitelist CIDR range
POST/api/whitelist/crowdsecAdd to CrowdSec whitelist
POST/api/whitelist/traefikAdd to Traefik whitelist
POST/api/whitelist/comprehensiveSetup comprehensive whitelist
DELETE/api/whitelist/removeRemove from whitelist

Allowlist

MethodPathDescription
GET/api/allowlist/listList allowlists
POST/api/allowlist/createCreate allowlist
GET/api/allowlist/inspect/:nameInspect allowlist
POST/api/allowlist/addAdd entries
POST/api/allowlist/removeRemove entries
POST/api/allowlist/importImport entries
DELETE/api/allowlist/:nameDelete allowlist

Scenarios

MethodPathDescription
POST/api/scenarios/setupSetup custom scenarios
GET/api/scenarios/listList scenarios
GET/api/scenarios/filesGet scenario files
DELETE/api/scenarios/fileDelete scenario file

Captcha

MethodPathDescription
POST/api/captcha/setupSetup captcha
GET/api/captcha/statusGet captcha status
GET/api/captcha/detectDetect captcha config
POST/api/captcha/configSave captcha config
POST/api/captcha/applyApply captcha config

Logs

MethodPathDescription
GET/api/logs/crowdsecCrowdSec logs
GET/api/logs/traefikTraefik logs
GET/api/logs/traefik/advancedAdvanced Traefik log analysis
GET/api/logs/:serviceService logs
GET/api/logs/stream/:serviceStream logs (WebSocket)
GET/api/logs/structured/:serviceStructured log view

Backup

MethodPathDescription
GET/api/backup/listList backups
POST/api/backup/createCreate backup
POST/api/backup/restoreRestore backup
DELETE/api/backup/:idDelete backup
POST/api/backup/cleanupCleanup old backups
GET/api/backup/latestGet latest backup

Update

MethodPathDescription
GET/api/update/checkCheck for updates
POST/api/update/with-crowdsecUpdate with CrowdSec restart
POST/api/update/without-crowdsecUpdate without CrowdSec restart

Services

MethodPathDescription
GET/api/services/verifyVerify services
POST/api/services/shutdownGraceful shutdown
POST/api/services/actionService action

CrowdSec

MethodPathDescription
GET/api/crowdsec/bouncersList bouncers
POST/api/crowdsec/bouncersAdd bouncer
DELETE/api/crowdsec/bouncers/:nameDelete bouncer
GET/api/crowdsec/decisionsList decisions
POST/api/crowdsec/decisionsAdd decision
DELETE/api/crowdsec/decisionsDelete decision
POST/api/crowdsec/decisions/importImport decisions
GET/api/crowdsec/decisions/analysisDecision analysis
GET/api/crowdsec/decisions/historyDecision history
GET/api/crowdsec/decisions/repeated-offendersRepeated offenders
POST/api/crowdsec/decisions/history/reapplyReapply single decision
POST/api/crowdsec/decisions/history/bulk-reapplyBulk reapply decisions
GET/api/crowdsec/history/statsHistory statistics
GET/api/crowdsec/history/activityHistory activity
GET/api/crowdsec/history/configHistory config
PUT/api/crowdsec/history/configUpdate history config
GET/api/crowdsec/alerts/analysisAlert analysis
GET/api/crowdsec/alerts/historyAlert history
GET/api/crowdsec/alerts/:idInspect alert
DELETE/api/crowdsec/alerts/:idDelete alert
GET/api/crowdsec/metricsCrowdSec metrics
POST/api/crowdsec/enrollEnroll in CrowdSec console
POST/api/crowdsec/enroll/finalizeFinalize enrollment
GET/api/crowdsec/enroll/preferencesGet enrollment preferences
PUT/api/crowdsec/enroll/preferencesUpdate enrollment preferences
GET/api/crowdsec/statusEnrollment status

Traefik

MethodPathDescription
GET/api/traefik/configGet Traefik config
GET/api/traefik/config-pathGet config path
POST/api/traefik/config-pathSet config path

Config

MethodPathDescription
GET/api/config/settingsGet settings
PUT/api/config/settingsUpdate settings
GET/api/config/files/:container/:fileTypeGet container file content

Config Validation

MethodPathDescription
GET/api/config/validation/validateValidate configs
GET/api/config/validation/snapshotsList snapshots
POST/api/config/validation/snapshotCreate snapshot
POST/api/config/validation/restore/:typeRestore config
POST/api/config/validation/accept/:typeAccept current config
DELETE/api/config/validation/snapshot/:typeDelete snapshot

Notifications

MethodPathDescription
GET/api/notifications/discordGet Discord config
POST/api/notifications/discordUpdate Discord config
GET/api/notifications/discord/previewPreview Discord config
GET/api/notifications/discord/detectDetect Discord config
POST/api/notifications/discord/configSave Discord config
POST/api/notifications/discord/applyApply Discord config

Cron

MethodPathDescription
POST/api/cron/setupSetup cron job
GET/api/cron/listList cron jobs
DELETE/api/cron/:idDelete cron job

Profiles

MethodPathDescription
GET/api/profilesGet profiles
POST/api/profilesUpdate profiles

Hub

MethodPathDescription
GET/api/hub/listList all hub items
POST/api/hub/upgradeUpgrade all hub items
GET/api/hub/categoriesList categories
GET/api/hub/:category/itemsList items by category
POST/api/hub/:category/installInstall hub item
POST/api/hub/:category/removeRemove hub item
POST/api/hub/:category/manual-applyManual apply hub YAML
GET/api/hub/preferencesGet hub preferences
GET/api/hub/preferences/:categoryGet preference by category
PUT/api/hub/preferences/:categoryUpdate preference
GET/api/hub/historyHub operation history
GET/api/hub/history/:idHub operation by ID

Simulation

MethodPathDescription
GET/api/simulation/statusGet simulation status
POST/api/simulation/toggleToggle simulation mode

Hosts

MethodPathDescription
GET/api/hosts/listList Docker hosts

Terminal

MethodPathDescription
GET/api/terminal/:containerWebSocket terminal session

Events

MethodPathDescription
GET/api/events/wsWebSocket event stream
GET/api/events/sseSSE event stream

Logs API

Log access endpoints

Whitelist API

Whitelist management endpoints

On this page

API OverviewBase URLAuthenticationResponse FormatSuccess ResponseSuccess with messageError ResponseEndpoint ReferenceHealthIPWhitelistAllowlistScenariosCaptchaLogsBackupUpdateServicesCrowdSecTraefikConfigConfig ValidationNotificationsCronProfilesHubSimulationHostsTerminalEvents