npx skills add ...
npx skills add openai/plugins --skill vercel-firewall
npx skills add openai/plugins --skill vercel-firewall
Vercel Firewall and security expert guidance. Use when configuring DDoS protection, WAF rules, rate limiting, bot filtering, IP allow/block lists, OWASP rulesets, Attack Challenge Mode, or any security configuration on the Vercel platform.
You are an expert in the Vercel Firewall — a multi-layered security solution with automatic DDoS protection, a customizable Web Application Firewall (WAF), bot management, and rate limiting.
Changes propagate globally in under 300ms. No redeployment required.
No configuration needed — DDoS protection is always active.
Logic: Each object in conditionGroup is an OR group. Conditions within a single group are ANDed. Multiple groups are ORed.
| Type | Description | Extra Fields |
|---|---|---|
path | URL path | |
method | HTTP method | |
host | Hostname | |
ip_address | Client IP (supports CIDR) | |
user_agent | User-Agent string | |
header | Request header value | key (header name) |
query | Query string parameter | key (param name) |
cookie | Cookie value | key (cookie name) |
geo_country | ISO country code (e.g., US) | |
geo_continent | Continent code (e.g., NA) | |
geo_country_region | State/province code | |
geo_city | City name | |
geo_as_number | ASN | |
ja4_digest | JA4 TLS fingerprint | |
ja3_digest | JA3 TLS fingerprint | |
target_path | Resolved path after routing | |
route | Matched route pattern | |
raw_path | Raw unparsed path | |
region | Vercel edge region code | |
protocol | http/https | |
scheme | URL scheme | |
environment | Deployment environment | |
bot_name | Specific bot name | |
bot_category | Bot category | |
server_action | Next.js Server Action ID |
| Op | Meaning |
|---|---|
eq | Equals |
neq | Not equals |
re | Regex match |
pre | Starts with |
suf | Ends with |
sub | Contains |
inc | In array |
ninc | Not in array |
ex | Exists |
nex | Not exists |
gt / gte | Greater than (or equal) |
lt / lte | Less than (or equal) |
Additional optional fields: neg: true negates the condition, key required for header/query/cookie types.
| Action | Description |
|---|---|
log | Log only, allow traffic |
deny | Block request (403) |
challenge | JavaScript browser challenge |
bypass | Skip all subsequent WAF rules |
rate_limit | Apply rate limiting (requires rateLimit config) |
redirect | Redirect (requires redirect config) |
By default each request is evaluated individually. With persistent actions, rules are applied to all matching requests for a customizable duration (actionDuration), allowing the firewall to remember malicious behavior and block it earlier in the lifecycle.
| Field | Type | Description |
|---|---|---|
algo | string | "fixed_window" (all plans) or "token_bucket" (Enterprise) |
window | number | Seconds. Min 10, max 600 (Pro), max 3600 (Enterprise) |
limit | number | Max requests per window |
keys | array | Count per: "ip", "ja4", "user_agent", custom headers (Enterprise) |
action | string | When exceeded: "deny", "log", "challenge" |
When exceeded with deny, returns HTTP 429 with X-RateLimit-Limit and X-RateLimit-Remaining headers.
Heuristics-based detection that challenges non-browser bot traffic without disrupting verified webhook providers. Formerly "Bot Filter" during beta — renamed to Bot Protection at GA. Enable in log-only mode first to preview traffic impact:
Note: The older
bot_filterID is deprecated. Usebot_protectionin new configurations.
Block known AI crawlers (GPTBot, ClaudeBot, etc.):
Place this higher in priority than Bot Protection managed rules:
| Action | Effect |
|---|---|
deny | Block the IP |
challenge | Serve JS challenge |
log | Log traffic only |
bypass | Allow through all rules (allowlist) |
Note: hostname must match the exact domain. Add separate entries per subdomain.
| ID | Protection |
|---|---|
sqli | SQL Injection |
xss | Cross-Site Scripting |
rce | Remote Code Execution |
lfi | Local File Inclusion |
rfi | Remote File Inclusion |
sd | Scanner Detection |
ma | Multipart Attack |
php | PHP-specific exploits |
gen | Generic attack patterns |
sf | Session Fixation |
java | Java-specific exploits |
Base URL: https://api.vercel.com
Auth: Authorization: Bearer <VERCEL_TOKEN>
Query params: ?projectId=<id>&teamId=<id>
| Method | Path | Description |
|---|---|---|
GET | /v1/security/firewall/config/active | Read current config |
PATCH | /v1/security/firewall/config | Incremental update (add/remove/update rules) |
PUT | /v1/security/firewall/config | Full config replacement |
POST | /v1/security/firewall/bypass | Create temporary bypass rule |
| Action | Description |
|---|---|
firewallEnabled | Enable/disable firewall (value: boolean) |
rules.insert | Add a custom rule |
rules.update | Update rule (requires id) |
rules.remove | Delete rule (requires id) |
rules.priority | Reorder rule (requires id, value = index) |
ip.insert | Add IP rule |
ip.update | Update IP rule |
ip.remove | Delete IP rule |
crs.update | Enable/configure OWASP CRS rule |
crs.disable | Disable entire CRS |
managedRules.update | Configure managed ruleset |
Declaratively define firewall rules in vercel.json using the mitigate key:
Supported actions in vercel.json: "challenge", "deny" only. Rate limiting, log, and bypass require the Vercel Firewall dashboard at https://vercel.com/{team}/{project}/firewall or the REST API.
https://vercel.com/{team}/{project}/firewall → Bot Management → Attack Challenge Mode| Feature | Hobby | Pro | Enterprise |
|---|---|---|---|
| DDoS Protection | All | All | All |
| Custom Rules | 5 | 40 | 1000 |
| Rate Limiting | 1 rule | 40 rules | 1000 rules |
| Bot Protection (GA) | Yes | Yes | Yes |
| OWASP CRS | — | — | Yes |
| Token Bucket algo | — | — | Yes |
| Custom rate limit keys | — | — | Yes |
{
"action": {
"mitigate": {
"action": "deny",
"actionDuration": "1h",
"bypassSystem": false,
"logHeaders": ["user-agent", "x-forwarded-for"],
"redirect": {
"location": "https://example.com/blocked",
"permanent": false
}
}
}
}{
"name": "Block OFAC Sanctioned Countries",
"active": true,
"conditionGroup": [
{
"conditions": [
{
"type": "geo_country",
"op": "inc",
"value": ["CU", "IR", "KP", "RU", "SY"]
}
]
}
],
"action": {
"mitigate": { "action": "deny" }
}
}{
"name": "Require API Key",
"active": true,
"conditionGroup": [
{
"conditions": [
{
"type": "header",
"op": "nex",
"key": "x-api-key"
},
{
"type": "path",
"op": "pre",
"value": "/api/"
}
]
}
],
"action": {
"mitigate": { "action": "deny" }
}
}{
"name": "Block Known Malicious JA4",
"active": true,
"conditionGroup": [
{
"conditions": [
{
"type": "ja4_digest",
"op": "eq",
"value": "t13d1516h2_8daaf6152771_b0da82dd1658"
}
]
}
],
"action": {
"mitigate": { "action": "deny", "actionDuration": "1h" }
}
}{
"name": "Block Known Datacenter ASNs",
"active": true,
"conditionGroup": [
{
"conditions": [
{
"type": "geo_as_number",
"op": "inc",
"value": ["14618", "16509", "15169"]
}
]
}
],
"action": {
"mitigate": { "action": "deny" }
}
}{
"name": "Challenge cURL",
"active": true,
"conditionGroup": [
{
"conditions": [
{ "type": "user_agent", "op": "re", "value": "^curl/" }
]
}
],
"action": {
"mitigate": { "action": "challenge" }
}
}{
"name": "API Rate Limit - 100 req/min",
"active": true,
"conditionGroup": [
{
"conditions": [
{ "type": "path", "op": "pre", "value": "/api/" }
]
}
],
"action": {
"mitigate": {
"action": "rate_limit",
"rateLimit": {
"algo": "fixed_window",
"window": 60,
"limit": 100,
"keys": ["ip"],
"action": "deny"
}
}
}
}{
"name": "Login Rate Limit",
"active": true,
"conditionGroup": [
{
"conditions": [
{ "type": "path", "op": "eq", "value": "/api/auth/login" },
{ "type": "method", "op": "eq", "value": "POST" }
]
}
],
"action": {
"mitigate": {
"action": "rate_limit",
"rateLimit": {
"algo": "fixed_window",
"window": 60,
"limit": 10,
"keys": ["ip"],
"action": "challenge"
}
}
}
}{
"action": "managedRules.update",
"id": "bot_protection",
"value": { "active": true, "action": "challenge" }
}{
"action": "managedRules.update",
"id": "ai_bots",
"value": { "active": true, "action": "deny" }
}{
"name": "Allow My Monitoring Bot",
"active": true,
"conditionGroup": [
{
"conditions": [
{ "type": "user_agent", "op": "eq", "value": "MyMonitorBot/1.0" }
]
}
],
"action": {
"mitigate": { "action": "bypass" }
}
}{ "botIdEnabled": true }{
"action": "ip.insert",
"value": {
"hostname": "my-site.com",
"ip": "203.0.113.45",
"action": "deny",
"notes": "Malicious scraper"
}
}{
"action": "ip.insert",
"value": {
"hostname": "my-site.com",
"ip": "203.0.113.0/24",
"action": "deny",
"notes": "Bad actor CIDR block"
}
}{
"action": "ip.insert",
"value": {
"hostname": "my-site.com",
"ip": "198.51.100.1",
"action": "bypass",
"notes": "Internal monitoring IP"
}
}{
"action": "crs.update",
"id": "sqli",
"value": { "active": true, "action": "deny" }
}{
"firewallEnabled": true,
"crs": {
"sqli": { "active": true, "action": "deny" },
"xss": { "active": true, "action": "deny" },
"rce": { "active": true, "action": "deny" },
"lfi": { "active": true, "action": "deny" },
"rfi": { "active": true, "action": "deny" },
"sd": { "active": true, "action": "log" },
"ma": { "active": true, "action": "deny" },
"gen": { "active": true, "action": "deny" },
"sf": { "active": true, "action": "deny" },
"php": { "active": false, "action": "log" },
"java": { "active": false, "action": "log" }
},
"managedRules": {
"owasp": { "active": true, "action": "deny" },
"bot_protection": { "active": true, "action": "challenge" },
"ai_bots": { "active": true, "action": "deny" }
},
"botIdEnabled": true
}curl -X PATCH "https://api.vercel.com/v1/security/firewall/config?projectId=prj_xxx&teamId=team_xxx" \
-H "Authorization: Bearer $VERCEL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"action": "rules.insert",
"value": {
"name": "Block WordPress scanners",
"active": true,
"conditionGroup": [
{
"conditions": [
{ "type": "path", "op": "re", "value": "^/wp-(admin|login|content|includes)/" }
]
}
],
"action": { "mitigate": { "action": "deny" } }
}
}'import { Vercel } from '@vercel/sdk'
const vercel = new Vercel({ bearerToken: process.env.VERCEL_TOKEN })
// Read current firewall config
const config = await vercel.security.readFirewallConfig({
configVersion: 'active',
projectId: 'prj_xxx',
teamId: 'team_xxx',
})
// Add a rule
await vercel.security.updateFirewallConfig({
projectId: 'prj_xxx',
teamId: 'team_xxx',
requestBody: {
action: 'rules.insert',
value: {
name: 'Rate limit API',
active: true,
conditionGroup: [
{ conditions: [{ type: 'path', op: 'pre', value: '/api/' }] },
],
action: {
mitigate: {
action: 'rate_limit',
rateLimit: { algo: 'fixed_window', window: 60, limit: 100, keys: ['ip'], action: 'deny' },
},
},
},
},
})curl -X POST "https://api.vercel.com/v1/security/firewall/bypass?projectId=prj_xxx&teamId=team_xxx" \
-H "Authorization: Bearer $VERCEL_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"domain": "my-site.com",
"sourceIp": "198.51.100.42",
"ttl": 3600000,
"note": "Temporary bypass for load testing"
}'{
"$schema": "https://openapi.vercel.sh/vercel.json",
"routes": [
{
"src": "/api/(.*)",
"missing": [
{ "type": "header", "key": "x-internal-token" }
],
"mitigate": { "action": "deny" }
},
{
"src": "/(.*)",
"has": [
{ "type": "header", "key": "user-agent", "value": "(?i)^curl/" }
],
"mitigate": { "action": "challenge" }
}
]
}