Update Firewall Configuration

APIs & SDKs

PATCHhttps://api.vercel.com/v1/security/firewall/config

Process updates to modify the existing firewall config for a project

https://api.vercel.com/v1/security/firewall/config

const response = await fetch('https://api.vercel.com/v1/security/firewall/config?projectId=string&teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "action": "firewallEnabled",
    "id": "value",
    "value": {
      "name": "Example Name",
      "description": "string",
      "active": "true",
      "conditionGroup": [
        {
          "conditions": [
            {
              "type": "host",
              "op": "re",
              "neg": "true",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "action": {
        "mitigate": {
          "action": "deny"
        }
      },
      "valid": "true",
      "validationErrors": []
    }
  }),
});

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

Response

"value"

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringRequired

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

actionstringRequired

idobjectOptional

valueobjectRequired

Response

200Success

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

402Error

403You do not have permission to access this resource.

404Error

410Error

500Error

https://api.vercel.com/v1/security/firewall/config

const response = await fetch('https://api.vercel.com/v1/security/firewall/config?projectId=string&teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "action": "firewallEnabled",
    "id": "value",
    "value": {
      "name": "Example Name",
      "description": "string",
      "active": "true",
      "conditionGroup": [
        {
          "conditions": [
            {
              "type": "host",
              "op": "re",
              "neg": "true",
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "action": {
        "mitigate": {
          "action": "deny"
        }
      },
      "valid": "true",
      "validationErrors": []
    }
  }),
});

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

Response

"value"

OpenAPI Specification