-
Notifications
You must be signed in to change notification settings - Fork 89
first version of cti api key/plan page #693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
|  | ||
|
|
||
| <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: | ||
rr404 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| `/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) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| --- | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.