Update Protection Bypass for Automation

APIs & SDKs

PATCH/__remote/api.vercel.com/v1/projects/{idOrName}/protection-bypass

Update the deployment protection automation bypass for a project

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.updateProjectProtectionBypass({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {},
  });

  console.log(result);
}

run();

Response

{
  "protectionBypass": "value"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired

The unique project identifier or the project name

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

revokeobjectOptional

Optional instructions for revoking and regenerating a automation bypass

generateobjectOptional

Generate a new secret. If neither generate or revoke are provided, a new random secret will be generated.

updateobjectOptional

Update an existing bypass

Response

200Success

protectionBypassobjectOptional

Errors

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

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.updateProjectProtectionBypass({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {},
  });

  console.log(result);
}

run();

Response

{
  "protectionBypass": "value"
}

OpenAPI Specification