Skip to content
Docs

Read System Bypass

GEThttps://api.vercel.com/v1/security/firewall/bypass
Retrieve the system bypass rules configured for the specified project
Request
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();
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
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