Read System Bypass | Vercel REST API

APIs & SDKs

Read System Bypass

GEThttps://api.vercel.com/v1/security/firewall/bypass

Retrieve the system bypass rules configured for the specified project

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

const response = await fetch('https://api.vercel.com/v1/security/firewall/bypass?projectId=string&limit=123&sourceIp=string&domain=string&projectScope=true&offset=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "pagination": {
    "Id": "icfg_1234567890",
    "OwnerId": "example_id"
  },
  "result": [
    {
      "Action": "block",
      "ActorId": "example_id",
      "CreatedAt": "string",
      "DeletedAt": "string",
      "Domain": "string",
      "ExpiresAt": "123",
      "Id": "icfg_1234567890",
      "Ip": "string",
      "IsProjectRule": "false",
      "Note": "string",
      "OwnerId": "example_id",
      "ProjectId": "example_id",
      "UpdatedAt": "string",
      "UpdatedAtHour": "string"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringRequired

limitnumberOptional

sourceIpstringOptional

Filter by source IP

domainstringOptional

Filter by domain

projectScopebooleanOptional

Filter by project scoped rules

offsetstringOptional

Used for pagination. Retrieves results after the provided id

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

paginationobjectOptional

resultarrayRequired

Errors

400One 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

Cross-link map: Read System Bypass (/docs/rest-api/security/read-system-bypass)

From the Vercel docs graph (built 2026-10-09T15:41:22.984Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Create System Bypass Rule — POST /v1/security/firewall/bypass — Create new system bypass rules
Remove System Bypass Rule — DELETE /v1/security/firewall/bypass — Remove system bypass rules
Read Firewall Actions by Project — GET /v1/security/firewall/events — Retrieve firewall actions for a project Rule names are resolved against the project's
Read Firewall Actions Summary by Project — GET /v1/security/firewall/events/summary — Aggregate counts over the firewall actions matched by the same filters as \`G
Update Protection Bypass for Automation — PATCH /v1/projects/{idOrName}/protection-bypass — Update the deployment protection automation bypass for a project

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

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

const response = await fetch('https://api.vercel.com/v1/security/firewall/bypass?projectId=string&limit=123&sourceIp=string&domain=string&projectScope=true&offset=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "pagination": {
    "Id": "icfg_1234567890",
    "OwnerId": "example_id"
  },
  "result": [
    {
      "Action": "block",
      "ActorId": "example_id",
      "CreatedAt": "string",
      "DeletedAt": "string",
      "Domain": "string",
      "ExpiresAt": "123",
      "Id": "icfg_1234567890",
      "Ip": "string",
      "IsProjectRule": "false",
      "Note": "string",
      "OwnerId": "example_id",
      "ProjectId": "example_id",
      "UpdatedAt": "string",
      "UpdatedAtHour": "string"
    }
  ]
}

OpenAPI Specification