---
title: "Generate a firewall rule from natural language"
method: POST
path: "/v1/security/firewall/config/generate-rule"
tags: ["security"]
---

# Generate a firewall rule from natural language

`POST /v1/security/firewall/config/generate-rule`

Generate a firewall rule from a natural language description.

## Query parameters

- `projectId` string
- `teamId` string
- `slug` string

## Response `200`

- object
  - `rule` object
    - `name` string, required
    - `description` string
    - `active` false | true, required
    - `conditionGroup` object[], required
      - `conditions` object[], required
        - `type` string, required
        - `op` string, required
        - `neg` false | true
        - `key` string
        - `value` union
          - string
          - number
          - string[]
    - `action` object, required
      - `mitigate` object
        - `action` string, required
        - `rateLimit` object, nullable
          - `algo` string, required
          - `window` number, required
          - `limit` number, required
          - `keys` string[], required
          - `action` string, nullable
        - `redirect` object, nullable
          - `location` string, required
          - `permanent` false | true, required
        - `actionDuration` string, nullable
  - `error` string

## Other responses

- `400` — One of the provided values in the request query is invalid.
- `401` — The request is not authorized.
- `403` — You do not have permission to access this resource.
- `404`
- `408`
- `410`
- `500`

---

[API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/61d1ba3f6dac/schema)