Skip to content
Docs

Create conditional firewall bypass

POST/__remote/api.vercel.com/v1/security/firewall/bypass/rules
Create a conditional firewall bypass rule for a project domain.
/__remote/api.vercel.com/v1/security/firewall/bypass/rules
const response = await fetch('/__remote/api.vercel.com/v1/security/firewall/bypass/rules?projectId=string&slug=string&teamId=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "domain": "string",
    "conditionGroup": [
      {
        "conditions": [
          {
            "type": "user_agent",
            "op": "eq",
            "value": "string",
            "key": "user-agent"
          }
        ]
      }
    ],
    "note": "string"
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "condition": "string",
  "conditionGroup": [
    {
      "conditions": [
        {
          "key": "string",
          "neg": "false",
          "op": "eq",
          "type": "bot_category",
          "value": "string"
        }
      ]
    }
  ],
  "createdAt": "string",
  "domain": "string",
  "id": "icfg_1234567890",
  "note": "string",
  "projectId": "example_id",
  "updatedAt": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringRequired
slugstringOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.

Body

application/json
domainstringRequired
conditionGrouparrayRequired
notestringOptional

Response

200Success
conditionstringRequired
conditionGrouparrayRequired
createdAtstringRequired
domainstringRequired
idstringRequired
notestringOptional
projectIdstringRequired
updatedAtstringRequired

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.
403You do not have permission to access this resource.
404Error
409Error
410Error