@@ -19,21 +19,57 @@ CrowdSec Manager is a web-based management interface for CrowdSec operations, Tr
1919
2020## Images
2121
22- <img width =" 1200 " height =" 630 " alt =" Dashboard " src =" /images/Dashboard.png " />
23- <img width =" 1200 " height =" 630 " alt =" Health & Diagnostics " src =" /images/Health & Diagnostics.png " />
24- <img width =" 1200 " height =" 630 " alt =" Whitelist Management " src =" /images/Whitelist Management.png " />
25- <img width =" 1200 " height =" 630 " alt =" IP Management " src =" /images/IP Management.png " />
26- <img width =" 1200 " height =" 630 " alt =" CrowdSec Allowlist Management " src =" /images/CrowdSec Allowlist Management.png " />
27- <img width =" 1200 " height =" 630 " alt =" Scenario Management " src =" /images/Scenario Management.png " />
28- <img width =" 1200 " height =" 630 " alt =" Captcha Setup " src =" /images/Captcha Setup.png " />
29- <img width =" 1200 " height =" 630 " alt =" Decision List Analysis " src =" /images/Decision List Analysis.png " />
30- <img width =" 1200 " height =" 630 " alt =" Alert List Analysis " src =" /images/Alert List Analysis.png " />
31- <img width =" 1200 " height =" 630 " alt =" Logs Viewer " src =" /images/Logs Viewer.png " />
32- <img width =" 1200 " height =" 630 " alt =" Backup Management " src =" /images/Backup Management.png " />
33- <img width =" 1200 " height =" 630 " alt =" System Update " src =" /images/System Update.png " />
34- <img width =" 1200 " height =" 630 " alt =" Cron Job Management " src =" /images/Cron Job Management.png " />
35- <img width =" 1200 " height =" 630 " alt =" Services Management " src =" /images/Services Management.png " />
36- <img width =" 1200 " height =" 630 " alt =" Configuration " src =" /images/Configuration.png " />
22+ <img width =" 1200 " height =" 630 " alt =" Dashboard " src =" /images/dashboard-overview-countries-systems.jpeg " />
23+ <img width =" 1200 " height =" 630 " alt =" Health & Diagnostics " src =" /images/health-diagnostics-overview.jpeg " />
24+ <img width =" 1200 " height =" 630 " alt =" Whitelist Management " src =" /images/whitelist-management.jpeg " />
25+ <img width =" 1200 " height =" 630 " alt =" IP Management " src =" /images/ip-management.jpeg " />
26+ <img width =" 1200 " height =" 630 " alt =" CrowdSec Allowlist Management " src =" /images/allowlists-management.jpeg " />
27+ <img width =" 1200 " height =" 630 " alt =" Scenario Management " src =" /images/scenarios-management.jpeg " />
28+ <img width =" 1200 " height =" 630 " alt =" Captcha Setup " src =" /images/captcha-protection-detect.jpeg " />
29+ <img width =" 1200 " height =" 630 " alt =" Decision List Analysis " src =" /images/decisions-analysis-overview.jpeg " />
30+ <img width =" 1200 " height =" 630 " alt =" Alert List Analysis " src =" /images/alerts-analysis-overview.jpeg " />
31+ <img width =" 1200 " height =" 630 " alt =" Logs Viewer " src =" /images/logs-service-logs.jpeg " />
32+ <img width =" 1200 " height =" 630 " alt =" Backup Management " src =" /images/backup-management.jpeg " />
33+ <img width =" 1200 " height =" 630 " alt =" System Update " src =" /images/system-update.jpeg " />
34+ <img width =" 1200 " height =" 630 " alt =" Services Management " src =" /images/services-management.jpeg " />
35+ <img width =" 1200 " height =" 630 " alt =" Configuration " src =" /images/configuration-settings.jpeg " />
36+
37+ ### Image Index
38+
39+ | Screenshot File | Page |
40+ | --- | --- |
41+ | ` alerts-analysis-filters.jpeg ` | Alerts Analysis (filters panel) |
42+ | ` alerts-analysis-inspect-modal.jpeg ` | Alerts Analysis (inspect modal) |
43+ | ` alerts-analysis-overview.jpeg ` | Alerts Analysis (overview charts) |
44+ | ` alerts-analysis-results-table.jpeg ` | Alerts Analysis (results table) |
45+ | ` allowlists-management.jpeg ` | Allowlists Management |
46+ | ` backup-management.jpeg ` | Backup Management |
47+ | ` bouncers-management.jpeg ` | Bouncers Management |
48+ | ` captcha-protection-detect.jpeg ` | Captcha Protection (detect) |
49+ | ` config-validation.jpeg ` | Config Validation |
50+ | ` configuration-settings.jpeg ` | Configuration Settings |
51+ | ` crowdsec-health-overview.jpeg ` | CrowdSec Health Overview |
52+ | ` dashboard-overview-countries-systems.jpeg ` | Dashboard (countries and systems) |
53+ | ` dashboard-overview-scenarios-blocked-ips.jpeg ` | Dashboard (scenarios and blocked IPs) |
54+ | ` decisions-analysis-overview.jpeg ` | Decisions Analysis (overview) |
55+ | ` decisions-results-table.jpeg ` | Decisions Analysis (results table) |
56+ | ` health-diagnostics-overview.jpeg ` | Health and Diagnostics |
57+ | ` hub-appsec-configurations.jpeg ` | Hub Browser (AppSec configurations) |
58+ | ` hub-appsec-rules.jpeg ` | Hub Browser (AppSec rules) |
59+ | ` hub-collections.jpeg ` | Hub Browser (collections) |
60+ | ` hub-home-categories.jpeg ` | Hub Browser (home categories) |
61+ | ` hub-log-parsers.jpeg ` | Hub Browser (log parsers) |
62+ | ` hub-postoverflows.jpeg ` | Hub Browser (postoverflows) |
63+ | ` hub-remediation-components.jpeg ` | Hub Browser (remediation components) |
64+ | ` hub-scenarios-install-mode.jpeg ` | Hub Browser (scenarios install mode) |
65+ | ` ip-management.jpeg ` | IP Management |
66+ | ` logs-service-logs.jpeg ` | Logs (service logs) |
67+ | ` notifications-detect.jpeg ` | Notifications (detect) |
68+ | ` scenarios-management.jpeg ` | Scenarios Management |
69+ | ` services-management.jpeg ` | Services Management |
70+ | ` system-update.jpeg ` | System Update |
71+ | ` terminal-container-shell.png ` | Terminal (container shell) |
72+ | ` whitelist-management.jpeg ` | Whitelist Management |
3773
3874## Minimum Docker Compose
3975
@@ -80,6 +116,160 @@ docker compose up -d
80116curl http://localhost:8080/health
81117```
82118
119+ ## API Endpoints
120+
121+ Base prefix: ` /api `
122+
123+ ### Health
124+ - ` GET /api/health/stack `
125+ - ` GET /api/health/crowdsec `
126+ - ` GET /api/health/complete `
127+
128+ ### IP
129+ - ` GET /api/ip/public `
130+ - ` GET /api/ip/blocked/:ip `
131+ - ` GET /api/ip/security/:ip `
132+ - ` POST /api/ip/unban `
133+
134+ ### Whitelist
135+ - ` GET /api/whitelist/view `
136+ - ` POST /api/whitelist/current `
137+ - ` POST /api/whitelist/manual `
138+ - ` POST /api/whitelist/cidr `
139+ - ` POST /api/whitelist/crowdsec `
140+ - ` POST /api/whitelist/traefik `
141+ - ` POST /api/whitelist/comprehensive `
142+ - ` DELETE /api/whitelist/remove `
143+
144+ ### Allowlist
145+ - ` GET /api/allowlist/list `
146+ - ` POST /api/allowlist/create `
147+ - ` GET /api/allowlist/inspect/:name `
148+ - ` POST /api/allowlist/add `
149+ - ` POST /api/allowlist/remove `
150+ - ` DELETE /api/allowlist/:name `
151+
152+ ### Scenarios
153+ - ` POST /api/scenarios/setup `
154+ - ` GET /api/scenarios/list `
155+ - ` GET /api/scenarios/files `
156+ - ` DELETE /api/scenarios/file `
157+
158+ ### Captcha
159+ - ` POST /api/captcha/setup `
160+ - ` GET /api/captcha/status `
161+ - ` GET /api/captcha/detect `
162+ - ` POST /api/captcha/config `
163+ - ` POST /api/captcha/apply `
164+
165+ ### Logs
166+ - ` GET /api/logs/crowdsec `
167+ - ` GET /api/logs/traefik `
168+ - ` GET /api/logs/traefik/advanced `
169+ - ` GET /api/logs/:service `
170+ - ` GET /api/logs/stream/:service `
171+ - ` GET /api/logs/structured/:service `
172+
173+ ### Backup
174+ - ` GET /api/backup/list `
175+ - ` POST /api/backup/create `
176+ - ` POST /api/backup/restore `
177+ - ` DELETE /api/backup/:id `
178+ - ` POST /api/backup/cleanup `
179+ - ` GET /api/backup/latest `
180+
181+ ### Update
182+ - ` GET /api/update/check `
183+ - ` POST /api/update/with-crowdsec `
184+ - ` POST /api/update/without-crowdsec `
185+
186+ ### Services
187+ - ` GET /api/services/verify `
188+ - ` POST /api/services/shutdown `
189+ - ` POST /api/services/action `
190+
191+ ### CrowdSec
192+ - ` GET /api/crowdsec/bouncers `
193+ - ` POST /api/crowdsec/bouncers `
194+ - ` DELETE /api/crowdsec/bouncers/:name `
195+ - ` GET /api/crowdsec/decisions `
196+ - ` POST /api/crowdsec/decisions `
197+ - ` DELETE /api/crowdsec/decisions `
198+ - ` POST /api/crowdsec/decisions/import `
199+ - ` GET /api/crowdsec/decisions/analysis `
200+ - ` GET /api/crowdsec/alerts/analysis `
201+ - ` GET /api/crowdsec/alerts/:id `
202+ - ` DELETE /api/crowdsec/alerts/:id `
203+ - ` GET /api/crowdsec/metrics `
204+ - ` POST /api/crowdsec/enroll `
205+ - ` POST /api/crowdsec/enroll/finalize `
206+ - ` GET /api/crowdsec/enroll/preferences `
207+ - ` PUT /api/crowdsec/enroll/preferences `
208+ - ` GET /api/crowdsec/status `
209+
210+ ### Traefik
211+ - ` GET /api/traefik/config `
212+ - ` GET /api/traefik/config-path `
213+ - ` POST /api/traefik/config-path `
214+
215+ ### Config
216+ - ` GET /api/config/settings `
217+ - ` PUT /api/config/settings `
218+ - ` GET /api/config/files/:container/:fileType `
219+
220+ ### Notifications
221+ - ` GET /api/notifications/discord `
222+ - ` POST /api/notifications/discord `
223+ - ` GET /api/notifications/discord/preview `
224+ - ` GET /api/notifications/discord/detect `
225+ - ` POST /api/notifications/discord/config `
226+ - ` POST /api/notifications/discord/apply `
227+
228+ ### Cron
229+ - ` POST /api/cron/setup `
230+ - ` GET /api/cron/list `
231+ - ` DELETE /api/cron/:id `
232+
233+ ### Profiles
234+ - ` GET /api/profiles `
235+ - ` POST /api/profiles `
236+
237+ ### Hosts
238+ - ` GET /api/hosts/list `
239+
240+ ### Terminal
241+ - ` GET /api/terminal/:container `
242+
243+ ### Config Validation
244+ - ` GET /api/config/validation/validate `
245+ - ` GET /api/config/validation/snapshots `
246+ - ` POST /api/config/validation/snapshot `
247+ - ` POST /api/config/validation/restore/:type `
248+ - ` POST /api/config/validation/accept/:type `
249+ - ` DELETE /api/config/validation/snapshot/:type `
250+
251+ ### Hub
252+ - ` GET /api/hub/list `
253+ - ` POST /api/hub/upgrade `
254+ - ` GET /api/hub/categories `
255+ - ` GET /api/hub/:category/items `
256+ - ` POST /api/hub/:category/install `
257+ - ` POST /api/hub/:category/remove `
258+ - ` POST /api/hub/:category/manual-apply `
259+ - ` GET /api/hub/preferences `
260+ - ` GET /api/hub/preferences/:category `
261+ - ` PUT /api/hub/preferences/:category `
262+ - ` GET /api/hub/history `
263+ - ` GET /api/hub/history/:id `
264+
265+ ### Simulation
266+ - ` GET /api/simulation/status `
267+ - ` POST /api/simulation/toggle `
268+
269+ ### Events
270+ - ` GET /api/events/ws `
271+ - ` GET /api/events/sse `
272+
83273## Documentation
84274
85275For installation details, feature guides, and API reference, use the docs in [ ` docs ` ] ( https://crowdsec-manager.hhf.technology ) .
0 commit comments