Getting Started
Last updated
Was this helpful?
Last updated
Was this helpful?
After you rent our Layer 7 protection, you'll receive a custom API token that grants you access to our management API.
Our API allows you to:
Add a domain
Change existing domain settings
Delete a domain
View clean traffic statistics
rate_limit_edge
Description: The maximum number of requests per second (RPS) allowed from a single IP per edge node.
conn_limit_edge
Description: The maximum number of open (simultaneous) connections allowed per single IP address per edge node.
burst_limit_edge
Description: The maximum short-term request burst allowed per client IP per edge node before temporary throttling kicks in.
backend
Description:
The IP address and port of your backend server where clean traffic should be forwarded.
Example:
"backend": "127.0.0.1:8082"
webhook_url
Description: Optional webhook URL that we’ll call when an attack is detected on this domain.
max_rq_stage_1
Description: Maximum number of global bypassing requests per second in Stage 1 (Cookie Challenge) before escalating to Stage 2 (Proof-of-Work Challenge).
max_rq_stage_2
Description: Maximum number of global bypassing requests per second in Stage 2 (Proof-of-Work Challenge) before escalating to Stage 3 (Captcha Challenge).
stage_diff_js_challenge
Description: Number of seconds that must pass before a JavaScript challenge is issued, based on changing traffic behavior.
Approximate Proof-of-Work (POW) Difficulty Timing:
Difficulty 4 → ~0.247 seconds
Difficulty 5 → ~3.100 seconds
Difficulty 6 → ~21.400 seconds
disable_bypass_stage_2
Description: Defines the maximum global request rate at which Stage 2 (Proof-of-Work Challenge) will be deactivated.
disable_bypass_stage_3
Description: Defines the maximum global request rate at which Stage 3 (Captcha Challenge) will be deactivated.
When you add a domain to our system, you must create a CNAME DNS record pointing to:
This allows our filtering system to handle your domain's traffic. Once the CNAME is in place and your domain is added via the API, you’re ready to go!