GET
/
v1
/
security
/
firewall
/
bypass
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",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "result": [
    {
      "OwnerId": "<string>",
      "Id": "<string>",
      "Domain": "<string>",
      "Ip": "<string>",
      "Action": "block",
      "ProjectId": "<string>",
      "IsProjectRule": true,
      "Note": "<string>",
      "CreatedAt": "<string>",
      "ActorId": "<string>",
      "UpdatedAt": "<string>",
      "UpdatedAtHour": "<string>",
      "DeletedAt": "<string>",
      "ExpiresAt": 123
    }
  ],
  "pagination": "<any>"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
projectId
string
required
​
limit
number
Required range: x <= 128
Example:

10

​
sourceIp
string

Filter by source IP

Maximum length: 49
​
domain
string

Filter by domain

Maximum length: 2544
​
projectScope
boolean

Filter by project scoped rules

​
offset
string

Used for pagination. Retrieves results after the provided id

Maximum length: 2560
​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json
​
result
object[]
required
​
pagination
any | null
required