Generate a firewall rule from natural language

APIs & SDKs

POSThttps://api.vercel.com/v1/security/firewall/config/generate-rule

Generate a firewall rule from a natural language description.

https://api.vercel.com/v1/security/firewall/config/generate-rule

const response = await fetch('https://api.vercel.com/v1/security/firewall/config/generate-rule?projectId=string&teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

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"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringOptional

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

errorstringOptional

ruleobjectOptional

Errors

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

Cross-link map: Generate a firewall rule from natural language (/docs/rest-api/security/generate-a-firewall-rule-from-natural-language)

From the Vercel docs graph (built 2026-10-10T05:32:43.016Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Generate a routing rule from natural language — POST /v1/projects/{projectId}/routes/generate — Generate a routing rule configuration from a natural language descriptio
Update Firewall Configuration — PATCH /v1/security/firewall/config — Process updates to modify the existing firewall config for a project
Create System Bypass Rule — POST /v1/security/firewall/bypass — Create new system bypass rules
Read Firewall Actions by Project — GET /v1/security/firewall/events — Retrieve firewall actions for a project Rule names are resolved against the project's
Create rule — POST /ai-gateway/rules — Create a routing rule

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/security/firewall/config/generate-rule

const response = await fetch('https://api.vercel.com/v1/security/firewall/config/generate-rule?projectId=string&teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

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"
  }
}

OpenAPI Specification