Update Firewall Configuration

PATCH

security

firewall

config

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

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

async function run() {
  const result = await vercel.security.updateFirewallConfig({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      action: "managedRules.update",
      id: "<id>",
      value: {
        active: true,
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();

{}

Authorizations

Authorization

string

header

required

Default authentication mechanism

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"

Body

application/json

Enable Firewall

action

enum<string>

required

Available options:

firewallEnabled

value

boolean

required

any | null

Enable Firewall

action

enum<string>

required

Available options:

firewallEnabled

value

boolean

required

any | null

Add a custom rule

action

enum<string>

required

Available options:

rules.insert

value

object

required

any | null

Update a custom rule

action

enum<string>

required

Available options:

rules.update

string

required

value

object

required

Remove a custom rule

action

enum<string>

required

Available options:

rules.remove

string

required

value

any | null

Reorder a custom rule

action

enum<string>

required

Available options:

rules.priority

string

required

value

number

required

Enable a managed rule

action

enum<string>

required

Available options:

crs.update

enum<string>

required

Available options:

sd,

ma,

lfi,

rfi,

rce,

php,

gen,

xss,

sqli,

sf,

java

value

object

required

Disable a managed rule

action

enum<string>

required

Available options:

crs.disable

any | null

value

any | null

Add an IP Blocking rule

action

enum<string>

required

Available options:

ip.insert

value

object

required

any | null

Update an IP Blocking rule

action

enum<string>

required

Available options:

ip.update

string

required

value

object

required

Remove an IPBlocking rule

action

enum<string>

required

Available options:

ip.remove

string

required

value

any | null

Update a managed ruleset

action

enum<string>

required

Available options:

managedRules.update

string

required

value

object

required

Update a managed rule group

action

string

required

string

required

value

object

required

Response

200

application/json

The response is of type object.

Put Firewall Configuration Read Firewall Configuration

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

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

async function run() {
  const result = await vercel.security.updateFirewallConfig({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      action: "managedRules.update",
      id: "<id>",
      value: {
        active: true,
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();

{}

Endpoints

Authorizations

Query Parameters

Body

Response