---
title: "Read System Bypass"
method: GET
path: "/v1/security/firewall/bypass"
tags: ["security"]
---

# Read System Bypass

`GET /v1/security/firewall/bypass`

## Request

- Base URL: `https://api.vercel.com`
- URL: `https://api.vercel.com/v1/security/firewall/bypass`
- Auth: HTTP bearer

Retrieve the system bypass rules configured for the specified project

## Query parameters

- `projectId` string, required
- `limit` number
- `sourceIp` string: Filter by source IP
- `domain` string: Filter by domain
- `projectScope` boolean: Filter by project scoped rules
- `offset` string: Used for pagination. Retrieves results after the provided id
- `teamId` string
- `slug` string

## Response `200`

- object
  - `pagination` object
    - `Id` string, required
    - `OwnerId` string, required
  - `result` object[], required
    - `Action` 'block' | 'bypass'
    - `ActorId` string
    - `CreatedAt` string, required
    - `DeletedAt` string
    - `Domain` string, required
    - `ExpiresAt` number, nullable
    - `Id` string, required
    - `Ip` string, required
    - `IsProjectRule` false | true
    - `Note` string
    - `OwnerId` string, required
    - `ProjectId` string
    - `UpdatedAt` string, required
    - `UpdatedAtHour` string, required

## Other responses

- `400`: One of the provided values in the request query is invalid.
- `401`: The request is not authorized.
- `402`
- `403`: You do not have permission to access this resource.
- `404`
- `410`
- `500`

## Changes

- **2026-09-03** `f2c3b0a5aef3`: 1 info
  - added the non-success response with the status `402`
- **2026-07-21** `2ae10ee9d21c`: 1 info
  - added the non-success response with the status `410`
- **2026-01-22** `c12186034433`: 2 warning
  - added the new `false` enum value to the `result/items/IsProjectRule` response property for the response status `200`
  - added the new `true` enum value to the `result/items/IsProjectRule` response property for the response status `200`
- **2025-10-09** `50caddad4ae7`: 1 breaking, 4 info
  - the response's body type changed from no type to `object` for status `200`
  - for the `query` request parameter `limit`, the max was increased from `128.00` to `256.00`
  - removed `subschema #1, subschema #2` from the response body `oneOf` list for the response status `200`
  - added the optional property `pagination` to the response with the `200` status
  - …1 more
- **2025-05-17** `67f6a93c3cd8`: 1 breaking, 1 info
  - added `subschema #1, subschema #2` to the response body `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the response body `oneOf` list for the response status `200`

[Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v1/security/firewall/bypass/get.md)

---

[API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)
