|
| 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 | + |
| 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) |
0 commit comments