POST
/
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.addBypassIp({
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

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

run();
{
  "ok": true,
  "result": [
    {
      "OwnerId": "<string>",
      "Id": "<string>",
      "Domain": "<string>",
      "Ip": "<string>",
      "ProjectId": "<string>",
      "Note": "<string>",
      "IsProjectRule": true
    }
  ],
  "pagination": "<any>"
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

projectId
string
required
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"

Body

application/json
domain
string
required
Maximum length: 2544
projectScope
boolean

If the specified bypass will apply to all domains for a project.

sourceIp
string
allSources
boolean
ttl
number

Time to live in milliseconds

note
string
Maximum length: 500

Response

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