Skip to content
Docs

Generate a firewall rule from natural language

POSThttps://api.vercel.com/v1/security/firewall/config/generate-rule
Generate a firewall rule from a natural language description.
Request
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.security.generateFirewallRule({
projectId: "<id>",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
});
console.log(result);
}
run();
Response
{
"error": "string",
"rule": {
"action": {
"mitigate": {
"action": "string",
"actionDuration": "string",
"rateLimit": {
"action": "string",
"algo": "string",
"keys": [],
"limit": "123",
"window": "123"
},
"redirect": {
"location": "string",
"permanent": "false"
}
}
},
"active": "false",
"conditionGroup": [
{
"conditions": [
{
"key": "string",
"neg": "false",
"op": "string",
"type": "string",
"value": "string"
}
]
}
],
"description": "string",
"name": "Example Name"
}
}
AuthorizationbearerToken

Default authentication mechanism

projectIdstringOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.
200Success
errorstringOptional
ruleobjectOptional
400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
408Error
410Error
500Error