Skip to content

Commit 1f93dac

Browse files
author
jdv
committed
first version of cti api key/plan page
1 parent ac78b21 commit 1f93dac

File tree

5 files changed

+64
-4
lines changed

5 files changed

+64
-4
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: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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.
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_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+
The different plans are the following:
31+
32+
## Ip Lookup Plans
33+
Those CTI API plans give you access to the search by IP and search query endpoints.
34+
They return CrowdSec CTI enriched information about IPS.
35+
IP returned will consume one token from your quota.
36+
37+
The CTI endpoint accessible with those keys are:
38+
`/smoke/{ip}` and `/smoke/search`
39+
40+
The plans quotas are the following:
41+
* Community CTI API Key (**1 free key** with a console account): **50 token/day**
42+
* Extended CTI API Key: [contact us to activate an extended key for additional quota ↗️](https://www.crowdsec.net/contact-threat-intelligence-subscription)
43+
44+
## Advanced plans
45+
Those CTI API plans extend access to all CTI API endpoints:
46+
* `/smoke` : Allowing batch IP lookup
47+
* `/fire` : Allowing a paginated pull of all enriched IPs from our CrowdSec Intelligence Blocklist
48+
49+
[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: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,17 @@ description: Get started with CrowdSec's Cyber Threat Intelligence (CTI) platfor
55

66
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!
77

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).
8+
> You can access CrowdSec's CTI via our **Web UI** on the [**CTI Home page** ↗️](https://app.crowdsec.net/cti)
9+
> Or [Create a **CTI API key** and use our **CTI API**](/u/console/cti/cti_api_keys)
910
10-
## What Can You Find on the Home Page?
11+
## Features on the CTI Web UI
1112

12-
The CTI home page is designed to give you instant access to valuable threat intelligence. Here’s what you’ll find:
13+
The CTI home page is designed to give you instant access to valuable **threat intelligence**. There’s what you’ll find:
14+
- [Features on the CTI Web UI](#features-on-the-cti-web-ui)
15+
- [Search Bar](#search-bar)
16+
- [Check Your Own IP](#check-your-own-ip)
17+
- [Predefined Searches](#predefined-searches)
18+
- [Top 10 Most Aggressive IPs](#top-10-most-aggressive-ips)
1319

1420
### Search Bar
1521

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)