Skip to content

Commit b555fd4

Browse files
rr404jdv
andauthored
first version of cti api key/plan page (#693)
* first version of cti api key/plan page --------- Co-authored-by: jdv <[email protected]>
1 parent c9a5f5d commit b555fd4

File tree

5 files changed

+68
-5
lines changed

5 files changed

+68
-5
lines changed

crowdsec-docs/sidebarsUnversioned.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,11 @@ module.exports = {
184184
label: "Getting started",
185185
id: "console/cti/getting_started",
186186
},
187+
{
188+
type: "doc",
189+
label: "CTI API Keys",
190+
id: "console/cti/cti_api_keys",
191+
},
187192
{
188193
type: "doc",
189194
label: "IP report",
111 KB
Loading
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: CTI API Keys
3+
description: What can you access in the CTI API
4+
---
5+
6+
import AcademyPromo from '@site/src/components/AcademyPromo';
7+
import ThemedImage from "@theme/ThemedImage";
8+
import useBaseUrl from "@docusaurus/useBaseUrl";
9+
10+
This section will describe how to access to our CTI API and the [different plans available](#ip-lookup-plans).
11+
If you want to know more about the CTI API itself, you can check the [CTI API documentation](/u/cti_api/getting_started).
12+
13+
# Creating a CTI API Key
14+
15+
You can create a CTI API key via the **+** short cut on the top right corner that will lead you to the CrowdSec Console settings, CTI API Key section.
16+
17+
![CTI API Key Creation](/img/console/cti/cti_api_create_key.png)
18+
19+
<ThemedImage
20+
alt="CrowdSec Create API Key Page"
21+
sources={{
22+
light: useBaseUrl("/img/console_create_api_key_page_light.png"),
23+
dark: useBaseUrl("/img/console_create_api_key_page_dark.png"),
24+
}}
25+
/>
26+
27+
# CTI Plans
28+
29+
The CTI API contains multiple endpoints that are not all accessible with any plan.
30+
You can check the Swagger [There ↗️](https://crowdsecurity.github.io/cti-api/).
31+
32+
The different plans are the following:
33+
34+
## Ip Lookup Plans
35+
Those CTI API plans give you access to the search by IP and search query endpoints.
36+
They return CrowdSec CTI enriched information about IPS.
37+
IP returned will consume one token from your quota.
38+
39+
The CTI endpoint accessible with those keys are:
40+
`/smoke/{ip}` and `/smoke/search`
41+
42+
The plans quotas are the following:
43+
* Community CTI API Key (**1 free key** with a console account): **50 token/day**
44+
* Extended CTI API Key: [Contact us to activate an extended key for additional quota ↗️](https://www.crowdsec.net/contact-threat-intelligence-subscription)
45+
46+
## Advanced plans
47+
Those CTI API plans extend access to all CTI API endpoints:
48+
* `/smoke` : Allowing batch IP lookup
49+
* `/fire` : To stream all enriched IPs from our CrowdSec Intelligence Blocklist
50+
51+
[Contact us to activate an extended key for additional quota ↗️](https://www.crowdsec.net/contact-threat-intelligence-subscription)

crowdsec-docs/unversioned/console/cti/getting_started.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ title: Getting Started
33
description: Get started with CrowdSec's Cyber Threat Intelligence (CTI) platform.
44
---
55

6-
Welcome to CrowdSec’s Cyber Threat Intelligence (CTI)! This guide will help you navigate the home page and make the most of its features, from searching for IP details to exploring real-time threat insights. Let’s get started!
6+
Welcome to **CrowdSec’s Cyber Threat Intelligence (CTI)**!
7+
This guide will help you navigate the **CTI Web UI** and make the most of its features, from searching for IP details to exploring real-time threat insights. Let’s get started!
78

8-
> You can access the [CTI Home page](https://app.crowdsec.net/cti) or directly call our [API](https://docs.crowdsec.net/u/cti_api/getting_started).
9+
> You can access CrowdSec's CTI via our **Web UI** on the [**CTI Home page** ↗️](https://app.crowdsec.net/cti)
10+
> Or [Create a **CTI API key** and use our **CTI API**](/u/console/cti/cti_api_keys)
911
10-
## What Can You Find on the Home Page?
12+
## Features on the CTI Web UI
1113

12-
The CTI home page is designed to give you instant access to valuable threat intelligence. Here’s what you’ll find:
14+
The **CTI home page** is designed to give you instant access to valuable **threat intelligence**. There’s what you’ll find:
15+
<!-- Not using bullet points to avoid VS annoying auto table of content "fix" -->
16+
[An IP or Query search bar](#search-bar)
17+
[A shortcut to search your own IP](#check-your-own-ip)
18+
[Predefined query to explore our CTI](#predefined-searches)
19+
[A top 10 of the most agressive IPs](#top-10-most-aggressive-ips)
1320

1421
### Search Bar
1522

crowdsec-docs/unversioned/cti_api/getting_started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: getting_started
3-
title: Getting Started
3+
title: CTI API Getting Started
44
sidebar_position: 2
55
---
66

0 commit comments

Comments
 (0)