Read Firewall Configuration

getFirewallConfig

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.security.getFirewallConfig({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    configVersion: "<value>",
  });

  console.log(result);
}

run();

{
  "ownerId": "<string>",
  "projectKey": "<string>",
  "id": "<string>",
  "version": 123,
  "updatedAt": "<string>",
  "firewallEnabled": true,
  "crs": {
    "sd": {
      "active": true,
      "action": "deny"
    },
    "ma": {
      "active": true,
      "action": "deny"
    },
    "lfi": {
      "active": true,
      "action": "deny"
    },
    "rfi": {
      "active": true,
      "action": "deny"
    },
    "rce": {
      "active": true,
      "action": "deny"
    },
    "php": {
      "active": true,
      "action": "deny"
    },
    "gen": {
      "active": true,
      "action": "deny"
    },
    "xss": {
      "active": true,
      "action": "deny"
    },
    "sqli": {
      "active": true,
      "action": "deny"
    },
    "sf": {
      "active": true,
      "action": "deny"
    },
    "java": {
      "active": true,
      "action": "deny"
    }
  },
  "rules": [
    {
      "id": "<string>",
      "name": "<string>",
      "active": true,
      "conditionGroup": [
        {
          "conditions": [
            {
              "type": "host",
              "op": "re",
              "neg": true,
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "action": {
        "mitigate": {
          "action": "deny",
          "rateLimit": {
            "algo": "fixed_window",
            "window": 123,
            "limit": 123,
            "keys": [
              "<string>"
            ],
            "action": "deny"
          },
          "redirect": {
            "location": "<string>",
            "permanent": true
          },
          "actionDuration": "<string>",
          "bypassSystem": true
        }
      },
      "description": "<string>"
    }
  ],
  "ips": [
    {
      "id": "<string>",
      "hostname": "<string>",
      "ip": "<string>",
      "action": "deny",
      "notes": "<string>"
    }
  ],
  "changes": [
    {}
  ],
  "managedRules": {
    "bot_protection": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    },
    "ai_bots": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    },
    "owasp": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    }
  },
  "botIdEnabled": true
}

GET

security

firewall

config

{configVersion}

getFirewallConfig

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.security.getFirewallConfig({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    configVersion: "<value>",
  });

  console.log(result);
}

run();

{
  "ownerId": "<string>",
  "projectKey": "<string>",
  "id": "<string>",
  "version": 123,
  "updatedAt": "<string>",
  "firewallEnabled": true,
  "crs": {
    "sd": {
      "active": true,
      "action": "deny"
    },
    "ma": {
      "active": true,
      "action": "deny"
    },
    "lfi": {
      "active": true,
      "action": "deny"
    },
    "rfi": {
      "active": true,
      "action": "deny"
    },
    "rce": {
      "active": true,
      "action": "deny"
    },
    "php": {
      "active": true,
      "action": "deny"
    },
    "gen": {
      "active": true,
      "action": "deny"
    },
    "xss": {
      "active": true,
      "action": "deny"
    },
    "sqli": {
      "active": true,
      "action": "deny"
    },
    "sf": {
      "active": true,
      "action": "deny"
    },
    "java": {
      "active": true,
      "action": "deny"
    }
  },
  "rules": [
    {
      "id": "<string>",
      "name": "<string>",
      "active": true,
      "conditionGroup": [
        {
          "conditions": [
            {
              "type": "host",
              "op": "re",
              "neg": true,
              "key": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "action": {
        "mitigate": {
          "action": "deny",
          "rateLimit": {
            "algo": "fixed_window",
            "window": 123,
            "limit": 123,
            "keys": [
              "<string>"
            ],
            "action": "deny"
          },
          "redirect": {
            "location": "<string>",
            "permanent": true
          },
          "actionDuration": "<string>",
          "bypassSystem": true
        }
      },
      "description": "<string>"
    }
  ],
  "ips": [
    {
      "id": "<string>",
      "hostname": "<string>",
      "ip": "<string>",
      "action": "deny",
      "notes": "<string>"
    }
  ],
  "changes": [
    {}
  ],
  "managedRules": {
    "bot_protection": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    },
    "ai_bots": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    },
    "owasp": {
      "active": true,
      "action": "deny",
      "updatedAt": "<string>",
      "userId": "<string>",
      "username": "<string>"
    }
  },
  "botIdEnabled": true
}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Path Parameters

configVersion

string

required

The deployed configVersion for the firewall configuration

Query Parameters

projectId

string

required

teamId

string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug

string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

If the firewall configuration includes a custom managed ruleset, it will include a crs item that has the following values: sd: Scanner Detection ma: Multipart Attack lfi: Local File Inclusion Attack rfi: Remote File Inclusion Attack rce: Remote Execution Attack php: PHP Attack gen: Generic Attack xss: XSS Attack sqli: SQL Injection Attack sf: Session Fixation Attack java: Java Attack

ownerId

string

required

projectKey

string

required

string

required

version

number

required

updatedAt

string

required

firewallEnabled

boolean

required

crs

object

required

Custom Ruleset

Show child attributes

crs.sd

object

required

Scanner Detection - Detect and prevent reconnaissance activities from network scanning tools.

Show child attributes

crs.sd.active

boolean

required

crs.sd.action

enum<string>

required

Available options:

deny,

log

crs.ma

object

required

Multipart Attack - Block attempts to bypass security controls using multipart/form-data encoding.

Show child attributes

crs.ma.active

boolean

required

crs.ma.action

enum<string>

required

Available options:

deny,

log

crs.lfi

object

required

Local File Inclusion Attack - Prevent unauthorized access to local files through web applications.

Show child attributes

crs.lfi.active

boolean

required

crs.lfi.action

enum<string>

required

Available options:

deny,

log

crs.rfi

object

required

Remote File Inclusion Attack - Prohibit unauthorized upload or execution of remote files.

Show child attributes

crs.rfi.active

boolean

required

crs.rfi.action

enum<string>

required

Available options:

deny,

log

crs.rce

object

required

Remote Execution Attack - Prevent unauthorized execution of remote scripts or commands.

Show child attributes

crs.rce.active

boolean

required

crs.rce.action

enum<string>

required

Available options:

deny,

log

crs.php

object

required

PHP Attack - Safeguard against vulnerability exploits in PHP-based applications.

Show child attributes

crs.php.active

boolean

required

crs.php.action

enum<string>

required

Available options:

deny,

log

crs.gen

object

required

Generic Attack - Provide broad protection from various undefined or novel attack vectors.

Show child attributes

crs.gen.active

boolean

required

crs.gen.action

enum<string>

required

Available options:

deny,

log

crs.xss

object

required

XSS Attack - Prevent injection of malicious scripts into trusted webpages.

Show child attributes

crs.xss.active

boolean

required

crs.xss.action

enum<string>

required

Available options:

deny,

log

crs.sqli

object

required

SQL Injection Attack - Prohibit unauthorized use of SQL commands to manipulate databases.

Show child attributes

crs.sqli.active

boolean

required

crs.sqli.action

enum<string>

required

Available options:

deny,

log

crs.sf

object

required

Session Fixation Attack - Prevent unauthorized takeover of user sessions by enforcing unique session IDs.

Show child attributes

crs.sf.active

boolean

required

crs.sf.action

enum<string>

required

Available options:

deny,

log

crs.java

object

required

Java Attack - Mitigate risks of exploitation targeting Java-based applications or components.

Show child attributes

crs.java.active

boolean

required

crs.java.action

enum<string>

required

Available options:

deny,

log

rules

object[]

required

Show child attributes

rules.id

string

required

rules.name

string

required

rules.active

boolean

required

rules.conditionGroup

object[]

required

Show child attributes

rules.conditionGroup.conditions

object[]

required

Show child attributes

rules.conditionGroup.conditions.type

enum<string>

required

Parameter from the incoming traffic.

Available options:

host,

path,

method,

header,

query,

cookie,

target_path,

route,

raw_path,

ip_address,

protocol,

region,

scheme,

environment,

user_agent,

geo_continent,

geo_country,

geo_country_region,

geo_city,

geo_as_number,

ja4_digest,

ja3_digest,

rate_limit_api_id,

server_action

rules.conditionGroup.conditions.op

enum<string>

required

Available options:

re,

eq,

ex,

inc,

pre,

suf,

sub,

gt,

gte,

lt,

lte,

nex,

ninc,

neq

rules.conditionGroup.conditions.neg

boolean

rules.conditionGroup.conditions.key

string

rules.conditionGroup.conditions.value

rules.action

object

required

Show child attributes

rules.action.mitigate

object

Show child attributes

rules.action.mitigate.action

enum<string>

required

Available options:

deny,

log,

challenge,

bypass,

rate_limit,

redirect

rules.action.mitigate.rateLimit

object

Show child attributes

rules.action.mitigate.rateLimit.algo

enum<string>

required

Available options:

fixed_window,

token_bucket

rules.action.mitigate.rateLimit.window

number

required

rules.action.mitigate.rateLimit.limit

number

required

rules.action.mitigate.rateLimit.keys

string[]

required

rules.action.mitigate.rateLimit.action

enum<string> | null

Available options:

deny,

log,

challenge,

rate_limit

rules.action.mitigate.redirect

object

Show child attributes

rules.action.mitigate.redirect.location

string

required

rules.action.mitigate.redirect.permanent

boolean

required

rules.action.mitigate.actionDuration

string | null

rules.action.mitigate.bypassSystem

boolean | null

rules.description

string

ips

object[]

required

Show child attributes

ips.id

string

required

ips.hostname

string

required

ips.ip

string

required

ips.action

enum<string>

required

Available options:

deny,

log,

challenge,

bypass

ips.notes

string

changes

object[]

required

managedRules

object

Show child attributes

managedRules.bot_protection

object

Show child attributes

managedRules.bot_protection.active

boolean

required

managedRules.bot_protection.action

enum<string>

Available options:

deny,

log,

challenge

managedRules.bot_protection.updatedAt

string

managedRules.bot_protection.userId

string

managedRules.bot_protection.username

string

managedRules.ai_bots

object

Show child attributes

managedRules.ai_bots.active

boolean

required

managedRules.ai_bots.action

enum<string>

Available options:

deny,

log,

challenge

managedRules.ai_bots.updatedAt

string

managedRules.ai_bots.userId

string

managedRules.ai_bots.username

string

managedRules.owasp

object

Show child attributes

managedRules.owasp.active

boolean

required

managedRules.owasp.action

enum<string>

Available options:

deny,

log,

challenge

managedRules.owasp.updatedAt

string

managedRules.owasp.userId

string

managedRules.owasp.username

string

botIdEnabled

boolean

Update Firewall Configuration Read active attack data

⌘I

Endpoints

Authorizations

Path Parameters

Query Parameters

Response