API reference
Arcjet API reference
Arcjet security: rate limit, bot, WAF
- Identifiers
- 104
- With full guides
- 0
- Types
- 6
Topics covered
- Setup
- Rate limiting
- Bot detection
- Email validation
- Shield (WAF)
- Next.js integration
- Node & Bun
- Testing rules
Function
| Name | What it does |
|---|
arcjet | Function |
shield | Function |
detectBot | Function |
tokenBucket | Function |
fixedWindow | Function |
slidingWindow | Function |
validateEmail | Function |
protectSignup | Function |
sensitiveInfo | Function |
request | Function |
isDenied | Function |
isAllowed | Function |
isRateLimit | Function |
isBot | Function |
createMiddleware | Function |
allowBots | Function |
Interface
| Name | What it does |
|---|
ArcjetDecision | Interface |
Type Alias
| Name | What it does |
|---|
ArcjetRule | Type Alias |
ArcjetReason | Type Alias |
ArcjetRequestDetails | Type Alias |
Const
| Name | What it does |
|---|
LIVE | Const |
DRY_RUN | Const |
CATEGORY:SEARCH_ENGINE | Const |
CATEGORY:MONITOR | Const |
CATEGORY:PREVIEW | Const |
allow | Const |
deny | Const |
DISPOSABLE | Const |
INVALID | Const |
NO_MX_RECORDS | Const |
FREE | Const |
EMAIL | Const |
PHONE_NUMBER | Const |
IP_ADDRESS | Const |
CREDIT_CARD_NUMBER | Const |
Bot detection | Const |
Rate limiting | Const |
Shield WAF | Const |
Email validation | Const |
Signup protection | Const |
PII detection | Const |
IP reputation | Const |
Fingerprinting | Const |
Characteristics | Const |
SQL injection protection | Const |
Spoofed bot detection | Const |
Hosting IP detection | Const |
Next.js | Const |
Node.js | Const |
Bun | Const |
Deno | Const |
SvelteKit | Const |
Remix | Const |
NestJS | Const |
Astro | Const |
Fixed window | Const |
Sliding window | Const |
Token bucket | Const |
Refill rate | Const |
Interval | Const |
Capacity | Const |
Max requests | Const |
Window size | Const |
Fingerprint | Const |
User ID characteristic | Const |
IP characteristic | Const |
Bot allow list | Const |
Bot deny list | Const |
Verified bots | Const |
Spoofed bots | Const |
Block disposable email | Const |
Require MX records | Const |
Allow free email | Const |
Requested tokens | Const |
Rule type | Const |
Rule mode | Const |
Module
| Name | What it does |
|---|
aj.protect | Module |
aj.withRule | Module |
decision.isDenied | Module |
decision.isAllowed | Module |
decision.isErrored | Module |
decision.isChallenged | Module |
decision.conclusion | Module |
decision.reason | Module |
decision.results | Module |
decision.ip | Module |
reason.isBot | Module |
reason.isRateLimit | Module |
reason.isShield | Module |
reason.isEmail | Module |
reason.isSensitiveInfo | Module |
reason.isError | Module |
rule.priority | Module |
decision.ttl | Module |
Pipe
| Name | What it does |
|---|
ip.isHosting | Pipe |
ip.isVpn | Pipe |
ip.isProxy | Pipe |
ip.isTor | Pipe |
ip.isRelay | Pipe |
ip.hasAccuracy | Pipe |
ip.latitude | Pipe |
ip.country | Pipe |
ip.asn | Pipe |
ip.service | Pipe |
Search across every package and filter by type in your dashboard.
Start learning