diff --git a/crowdsec-docs/sidebarsUnversioned.ts b/crowdsec-docs/sidebarsUnversioned.ts index aded4b970..8dcd7f2f7 100644 --- a/crowdsec-docs/sidebarsUnversioned.ts +++ b/crowdsec-docs/sidebarsUnversioned.ts @@ -408,13 +408,13 @@ const sidebarsUnversionedConfig: SidebarConfig = { tag: "otherSection", }, }, + { + type: "doc", + label: "IP Reputation Report", + id: "console/ip_reputation/ip_report", + }, ], }, - { - type: "doc", - label: "IP Reputation Report", - id: "console/ip_reputation/ip_report", - }, { type: "category", label: "API Keys", @@ -423,14 +423,6 @@ const sidebarsUnversionedConfig: SidebarConfig = { id: "console/ip_reputation/api_keys", }, items: [ - { - type: "doc", - label: "Premium API Keys", - id: "console/ip_reputation/api_keys_premium", - customProps: { - tag: "premium", - }, - }, { type: "link", label: "CTI API Integrations", diff --git a/crowdsec-docs/unversioned/console/ip_reputation/api_keys.mdx b/crowdsec-docs/unversioned/console/ip_reputation/api_keys.mdx index dfab3af02..a131e0a41 100644 --- a/crowdsec-docs/unversioned/console/ip_reputation/api_keys.mdx +++ b/crowdsec-docs/unversioned/console/ip_reputation/api_keys.mdx @@ -1,17 +1,50 @@ --- id: api_keys -title: CTI API Getting Started +title: CTI API Keys sidebar_position: 2 --- import AcademyPromo from '@site/src/components/academy-promo'; import ThemedImage from "@theme/ThemedImage"; import useBaseUrl from "@docusaurus/useBaseUrl"; +import Link from "@docusaurus/Link"; + +export const GREEN = "#22d3a0"; +export const BLUE = "#60a5fa"; +export const PURPLE = "#a78bfa"; + +CrowdSec CTI information can be navigated in the [WEB UI](/u/console/ip_reputation/search_ui) but for those who want to integrate CrowdSec's CTI into their tools and workflows, an API access is available through self-service API keys. +There are different quota options, from keys included in the current plan to higher-volume keys available as options to the premium plan. + +export const PremiumBadge = () => ( + Premium +); + +
+ {[ + { label: "Community Plan Free Key", quota: "40 / month", desc: "Testing integrations, personal servers, ad-hoc lookups", color: GREEN }, + { label: "Premium Plan Free Key", quota: "120 / month", desc: "Regular enrichment, small SOC teams, recurring automation", color: BLUE }, + { label: "Premium Keys Options", quota: "5K · 25K · 100K / month", desc: "Production SIEMs, SOARs, high-volume pipelines — requires Premium", color: PURPLE }, + ].map(({ label, quota, desc, color }) => ( +
+ {label} + {" — "} + {quota} + {" · "} + {desc} + {label.includes("Premium") && } +
+ ))} +
+
+ API quotas are separate from Web UI quotas. Unused quota does not roll over. +
## Create CTI API Keys +
- * Click the `+` in the top right corner. + * Click the `+` in the top right corner. * Alternatively you can also click the `+ New Key` in the **Settings → CTI API Keys** page.
@@ -29,13 +62,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
-There, you can choose among the various quota options. We provide a free key in order to test your integrations. -:::info -The free quota will be better if your organization is Premium than if it's on the free Community plan. -::: -:::info -Only Premium organizations can buy keys with higher quotas. See [Premium API Keys](/u/console/ip_reputation/api_keys_premium) for more details. -::: +There, you can choose among the various quota options. A free key is always available to test your integrations — the quota is higher if your organization is on a Premium plan.
+ +:::warning CTI API Keys and trials +- Purchasing a CTI API Key does **not** grant access to a Premium Plan trial. +- Purchasing a CTI API Key while a trial is active will **immediately end the trial**. +- Cancelled CTI API Keys are **non-refundable** and will not be prorated — the full price remains due regardless of when the cancellation occurs. +::: + +:::warning Lucene search via API +The Advanced Search Lucene query interface available in the Console is a Web UI feature only — it is not accessible through self-service API keys. Programmatic access to bulk Lucene-style querying requires an Advanced CTI plan. [Contact our team](https://www.crowdsec.net/contact-crowdsec?message=Advanced%20CTI%20plan%20discussion) to discuss your use case. +::: + ## Using the API CrowdSec provides [ready-made integrations](/u/cti_api/api_integration/integration_intro) for the most common security platforms — SIEM, SOAR, TIP, and investigation tools. If your platform is listed, that's the fastest way to get started. @@ -56,7 +94,7 @@ If you prefer to use your own scripts, call the API directly from the command li