You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: crowdsec-docs/docs/local_api/intro.md
+29-1Lines changed: 29 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
6
6
7
7
# Local API
8
8
9
-
The Local API (LAPI) is one of the core component of the Security Engine to :
9
+
The Local API (LAPI) is one of the core components of the Security Engine to :
10
10
11
11
- Allow Log Processors to push alerts & decisions to a database
12
12
- Allow Remediation Components to consume said alerts & decisions from database
@@ -15,3 +15,31 @@ The Local API (LAPI) is one of the core component of the Security Engine to :
15
15
You can find the swagger documentation [here](https://crowdsecurity.github.io/api_doc/lapi/).
16
16
17
17
This allows you to create [multi-machines architectures](https://crowdsec.net/multi-server-setup/) around CrowdSec or leverage [orchestration technologies](https://crowdsec.net/secure-docker-compose-stacks-with-crowdsec/).
18
+
19
+
All subcategories below are related to the Local API and its functionalities. If you are utilizing a multi server architecture, you will only need to configure the functionality that you want to use on the LAPI server.
20
+
21
+
For example if you wish to receive notifications then you will only need to configure the Notification Plugins on the LAPI server and not each [log processor](log_processor/intro.mdx).
22
+
23
+
## Authentication
24
+
25
+
LAPI offers multiple different authentication methods, which has their own restrictions based on the method used.
26
+
27
+
You can find more information about the authentication methods [here](local_api/authentication.md).
28
+
29
+
## Profiles
30
+
31
+
Profiles are a set of rules processed by the LAPI to determine if an alert should trigger a decision, notification or just simply log. They are processed in order of definition and can be used to make complex decisions based on the alert.
32
+
33
+
You can find more information about profiles [here](local_api/profiles/intro.md).
34
+
35
+
## Notification Plugins
36
+
37
+
Notification plugins are used to send alerts to external services.
38
+
39
+
You can find more information about configuring the plugins [here](local_api/notification_plugins/intro.md).
40
+
41
+
## Databases
42
+
43
+
Databases documentation showcases which database the LAPI supports and how to configure the database to allow the LAPI to utilize it.
44
+
45
+
You can find more information about the databases [here](local_api/database.md).
0 commit comments