Easily Integrate
CrowdSec's API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 15 SDK methods
Parameter
If true, means that the bouncers is starting and a full list must be provided
Comma separated scopes of decisions to fetch
Comma separated name of origins. If provided, then only the decisions originating from provided origins would be returned.
Comma separated words. If provided, only the decisions created by scenarios containing any of the provided word would be returned.
Comma separated words. If provided, only the decisions created by scenarios, not containing any of the provided word would be returned.
Response
error response return by the API
Endpoint
Parameter
If true, means that the bouncer is starting and a full list must be provided
Response
successful operation
400 response
Endpoint
Parameter
scope to which the decision applies (ie. IP/Range/Username/Session/...)
the value to match for in the specified scope
type of decision
IP to search for (shorthand for scope=ip&value=)
range to search for (shorthand for scope=range&value=)
scenario to search
Response
error response return by the API
Endpoint
Parameter
scope to which the decision applies (ie. IP/Range/Username/Session/...)
the value to match for in the specified scope
type of decision
IP to search for (shorthand for scope=ip&value=)
range to search for (shorthand for scope=range&value=)
indicate if you're looking for a decision that contains the value, or that is contained within the value
Comma separated name of origins. If provided, then only the decisions originating from provided origins would be returned.
Comma separated words. If provided, only the decisions created by scenarios containing any of the provided word would be returned.
Comma separated words. If provided, only the decisions created by scenarios, not containing any of the provided word would be returned.
Response
error response return by the API
Endpoint
Parameter
scope to which the decision applies (ie. IP/Range/Username/Session/...)
the value to match for in the specified scope
type of decision
IP to search for (shorthand for scope=ip&value=)
range to search for (shorthand for scope=range&value=)
indicate if you're looking for a decision that contains the value, or that is contained within the value
Response
successful operation
400 response
Endpoint
Parameter
Response
error response return by the API
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About CrowdSec
CrowdSec is a dual security engine designed to protect Internet-exposed workloads, whatever their type, task, or OS. It detects IP having bad behaviors in the logs and remedies the threat they pose in the most adapted way, using your existing network components. On top of that, when an IP is flagged, it's shared with CrowdSec network and, as long as enough trusted peers keep reporting it, the IP is maintained in our global real-time blocklist. That way everyone in the network is further protected by this network effect.