Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crowdsec-docs/sidebarsUnversioned.js
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ module.exports = {
label: "Getting started",
id: "console/cti/getting_started",
},
{
type: "doc",
label: "CTI API Keys",
id: "console/cti/cti_api_keys",
},
{
type: "doc",
label: "IP report",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions crowdsec-docs/unversioned/console/cti/cti_api_keys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: CTI API Keys
description: What can you access in the CTI API
---

import AcademyPromo from '@site/src/components/AcademyPromo';
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";

This section will describe how to access to our CTI API and the [different plans available](#ip-lookup-plans).
If you want to know more about the CTI API itself, you can check the [CTI API documentation](/u/cti_api/getting_started).

# Creating a CTI API Key

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.

![CTI API Key Creation](/img/console/cti/cti_api_create_key.png)

<ThemedImage
alt="CrowdSec Create API Key Page"
sources={{
light: useBaseUrl("/img/console_create_api_key_page_light.png"),
dark: useBaseUrl("/img/console_create_api_key_page_dark.png"),
}}
/>

# CTI Plans

The CTI API contains multiple endpoints that are not all accessible with any plan.
You can check the Swagger [There ↗️](https://crowdsecurity.github.io/cti-api/).

The different plans are the following:

## Ip Lookup Plans
Those CTI API plans give you access to the search by IP and search query endpoints.
They return CrowdSec CTI enriched information about IPS.
IP returned will consume one token from your quota.

The CTI endpoint accessible with those keys are:
`/smoke/{ip}` and `/smoke/search`

The plans quotas are the following:
* Community CTI API Key (**1 free key** with a console account): **50 token/day**
* Extended CTI API Key: [Contact us to activate an extended key for additional quota ↗️](https://www.crowdsec.net/contact-threat-intelligence-subscription)

## Advanced plans
Those CTI API plans extend access to all CTI API endpoints:
* `/smoke` : Allowing batch IP lookup
* `/fire` : To stream all enriched IPs from our CrowdSec Intelligence Blocklist

[Contact us to activate an extended key for additional quota ↗️](https://www.crowdsec.net/contact-threat-intelligence-subscription)
15 changes: 11 additions & 4 deletions crowdsec-docs/unversioned/console/cti/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@ title: Getting Started
description: Get started with CrowdSec's Cyber Threat Intelligence (CTI) platform.
---

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!
Welcome to **CrowdSec’s Cyber Threat Intelligence (CTI)**!
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!

> 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).
> You can access CrowdSec's CTI via our **Web UI** on the [**CTI Home page** ↗️](https://app.crowdsec.net/cti)
> Or [Create a **CTI API key** and use our **CTI API**](/u/console/cti/cti_api_keys)

## What Can You Find on the Home Page?
## Features on the CTI Web UI

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

### Search Bar

Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/unversioned/cti_api/getting_started.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: getting_started
title: Getting Started
title: CTI API Getting Started
sidebar_position: 2
---

Expand Down
Loading