---
title: read-system-bypass
product: vercel
url: /docs/rest-api/sdk/security/read-system-bypass
canonical_url: "https://vercel.com/docs/rest-api/sdk/security/read-system-bypass"
last_updated: 2026-09-16
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about read-system-bypass on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Read System Bypass

```http
GET /v1/security/firewall/bypass
```

Retrieve the system bypass rules configured for the specified project

## Authentication

**bearerToken**: HTTP bearer

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `projectId` | string | Yes |  |
| `limit` | number. max: 256 | No |  |
| `sourceIp` | string. maxLength: 49 | No | Filter by source IP |
| `domain` | string. maxLength: 2544; pattern: `([a-z]+[a-z.]+)$` | No | Filter by domain |
| `projectScope` | boolean | No | Filter by project scoped rules |
| `offset` | string. maxLength: 2560 | No | Used for pagination. Retrieves results after the provided id |
| `teamId` | string | No | The Team identifier to perform the request on behalf of. |
| `slug` | string | No | The Team slug to perform the request on behalf of. |


## Example request

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

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

async function run() {
  const result = await vercel.security.getBypassIp({
    projectId: "<id>",
    limit: 10,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
```

## Example response

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

## Responses

### 200: No description

Content-Type: `application/json`

```json
{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "CreatedAt",
          "Domain",
          "Id",
          "Ip",
          "OwnerId",
          "UpdatedAt",
          "UpdatedAtHour"
        ],
        "properties": {
          "OwnerId": {
            "type": "string"
          },
          "Id": {
            "type": "string"
          },
          "Domain": {
            "type": "string"
          },
          "Ip": {
            "type": "string"
          },
          "Action": {
            "type": "string",
            "enum": [
              "block",
              "bypass"
            ]
          },
          "ProjectId": {
            "type": "string"
          },
          "IsProjectRule": {
            "type": "boolean",
            "enum": [
              false,
              true
            ]
          },
          "Note": {
            "type": "string"
          },
          "CreatedAt": {
            "type": "string"
          },
          "ActorId": {
            "type": "string"
          },
          "UpdatedAt": {
            "type": "string"
          },
          "UpdatedAtHour": {
            "type": "string"
          },
          "DeletedAt": {
            "type": "string"
          },
          "ExpiresAt": {
            "type": "number",
            "nullable": true
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "Id",
        "OwnerId"
      ],
      "properties": {
        "OwnerId": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        }
      }
    }
  }
}
```

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

### 401: The request is not authorized.

### 402: No description

### 403: You do not have permission to access this resource.

### 404: No description

### 410: No description

### 500: No description

---

## Related

- [security endpoints](/docs/rest-api#security)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)