Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. ProjectProtectionBypass
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

vercel.ProjectProtectionBypass

vercel logo
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

    Provides a Project Protection Bypass resource.

    A Project Protection Bypass is an automation bypass token that allows automation services to bypass Deployment Protection on a vercel.Project using the x-vercel-protection-bypass HTTP header.

    Multiple bypasses can be created per project. Exactly one bypass per project may have is_env_var = true; that bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vercel from "@pulumiverse/vercel";

const example = new vercel.Project("example", {name: "example-project"});
// A bypass for a CI pipeline. Because this is the first bypass on the project,
// Vercel automatically marks it as the env-var default (is_env_var = true), and
// the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
const ci = new vercel.ProjectProtectionBypass("ci", {
    projectId: example.id,
    note: "ci pipeline",
});
// A second bypass for QA, with a caller-supplied secret.
const qa = new vercel.ProjectProtectionBypass("qa", {
    projectId: example.id,
    note: "preview QA",
    secret: "abcdefghijklmnopqrstuvwxyz123456",
});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.Project("example", name="example-project")
# A bypass for a CI pipeline. Because this is the first bypass on the project,
# Vercel automatically marks it as the env-var default (is_env_var = true), and
# the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
ci = vercel.ProjectProtectionBypass("ci",
    project_id=example.id,
    note="ci pipeline")
# A second bypass for QA, with a caller-supplied secret.
qa = vercel.ProjectProtectionBypass("qa",
    project_id=example.id,
    note="preview QA",
    secret="abcdefghijklmnopqrstuvwxyz123456")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-vercel/sdk/v5/go/vercel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
			Name: pulumi.String("example-project"),
		})
		if err != nil {
			return err
		}
		// A bypass for a CI pipeline. Because this is the first bypass on the project,
		// Vercel automatically marks it as the env-var default (is_env_var = true), and
		// the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
		_, err = vercel.NewProjectProtectionBypass(ctx, "ci", &vercel.ProjectProtectionBypassArgs{
			ProjectId: example.ID(),
			Note:      pulumi.String("ci pipeline"),
		})
		if err != nil {
			return err
		}
		// A second bypass for QA, with a caller-supplied secret.
		_, err = vercel.NewProjectProtectionBypass(ctx, "qa", &vercel.ProjectProtectionBypassArgs{
			ProjectId: example.ID(),
			Note:      pulumi.String("preview QA"),
			Secret:    pulumi.String("abcdefghijklmnopqrstuvwxyz123456"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumiverse.Vercel;

return await Deployment.RunAsync(() => 
{
    var example = new Vercel.Project("example", new()
    {
        Name = "example-project",
    });

    // A bypass for a CI pipeline. Because this is the first bypass on the project,
    // Vercel automatically marks it as the env-var default (is_env_var = true), and
    // the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
    var ci = new Vercel.ProjectProtectionBypass("ci", new()
    {
        ProjectId = example.Id,
        Note = "ci pipeline",
    });

    // A second bypass for QA, with a caller-supplied secret.
    var qa = new Vercel.ProjectProtectionBypass("qa", new()
    {
        ProjectId = example.Id,
        Note = "preview QA",
        Secret = "abcdefghijklmnopqrstuvwxyz123456",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.vercel.Project;
import com.pulumiverse.vercel.ProjectArgs;
import com.pulumiverse.vercel.ProjectProtectionBypass;
import com.pulumiverse.vercel.ProjectProtectionBypassArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()
            .name("example-project")
            .build());

        // A bypass for a CI pipeline. Because this is the first bypass on the project,
        // Vercel automatically marks it as the env-var default (is_env_var = true), and
        // the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
        var ci = new ProjectProtectionBypass("ci", ProjectProtectionBypassArgs.builder()
            .projectId(example.id())
            .note("ci pipeline")
            .build());

        // A second bypass for QA, with a caller-supplied secret.
        var qa = new ProjectProtectionBypass("qa", ProjectProtectionBypassArgs.builder()
            .projectId(example.id())
            .note("preview QA")
            .secret("abcdefghijklmnopqrstuvwxyz123456")
            .build());

    }
}

    resources:
  example:
    type: vercel:Project
    properties:
      name: example-project
  # A bypass for a CI pipeline. Because this is the first bypass on the project,
  # Vercel automatically marks it as the env-var default (is_env_var = true), and
  # the secret is exposed as VERCEL_AUTOMATION_BYPASS_SECRET on deployments.
  ci:
    type: vercel:ProjectProtectionBypass
    properties:
      projectId: ${example.id}
      note: ci pipeline
  # A second bypass for QA, with a caller-supplied secret.
  qa:
    type: vercel:ProjectProtectionBypass
    properties:
      projectId: ${example.id}
      note: preview QA
      secret: abcdefghijklmnopqrstuvwxyz123456

    Example coming soon!

    Create ProjectProtectionBypass Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProjectProtectionBypass(name: string, args: ProjectProtectionBypassArgs, opts?: CustomResourceOptions);
    @overload
def ProjectProtectionBypass(resource_name: str,
                            args: ProjectProtectionBypassArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ProjectProtectionBypass(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project_id: Optional[str] = None,
                            is_env_var: Optional[bool] = None,
                            note: Optional[str] = None,
                            secret: Optional[str] = None,
                            team_id: Optional[str] = None)
    func NewProjectProtectionBypass(ctx *Context, name string, args ProjectProtectionBypassArgs, opts ...ResourceOption) (*ProjectProtectionBypass, error)
    public ProjectProtectionBypass(string name, ProjectProtectionBypassArgs args, CustomResourceOptions? opts = null)
    public ProjectProtectionBypass(String name, ProjectProtectionBypassArgs args)
public ProjectProtectionBypass(String name, ProjectProtectionBypassArgs args, CustomResourceOptions options)

    type: vercel:ProjectProtectionBypass
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vercel_project_protection_bypass" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProjectProtectionBypassArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectProtectionBypassArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectProtectionBypassArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectProtectionBypassArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectProtectionBypassArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var projectProtectionBypassResource = new Vercel.ProjectProtectionBypass("projectProtectionBypassResource", new()
{
    ProjectId = "string",
    IsEnvVar = false,
    Note = "string",
    Secret = "string",
    TeamId = "string",
});

    example, err := vercel.NewProjectProtectionBypass(ctx, "projectProtectionBypassResource", &vercel.ProjectProtectionBypassArgs{
	ProjectId: pulumi.String("string"),
	IsEnvVar:  pulumi.Bool(false),
	Note:      pulumi.String("string"),
	Secret:    pulumi.String("string"),
	TeamId:    pulumi.String("string"),
})

    resource "vercel_project_protection_bypass" "projectProtectionBypassResource" {
  lifecycle {
    create_before_destroy = true
  }
  project_id = "string"
  is_env_var = false
  note       = "string"
  secret     = "string"
  team_id    = "string"
}

    var projectProtectionBypassResource = new ProjectProtectionBypass("projectProtectionBypassResource", ProjectProtectionBypassArgs.builder()
    .projectId("string")
    .isEnvVar(false)
    .note("string")
    .secret("string")
    .teamId("string")
    .build());

    project_protection_bypass_resource = vercel.ProjectProtectionBypass("projectProtectionBypassResource",
    project_id="string",
    is_env_var=False,
    note="string",
    secret="string",
    team_id="string")

    const projectProtectionBypassResource = new vercel.ProjectProtectionBypass("projectProtectionBypassResource", {
    projectId: "string",
    isEnvVar: false,
    note: "string",
    secret: "string",
    teamId: "string",
});

    type: vercel:ProjectProtectionBypass
properties:
    isEnvVar: false
    note: string
    projectId: string
    secret: string
    teamId: string

    ProjectProtectionBypass Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProjectProtectionBypass resource accepts the following input properties:

    ProjectId string
    The ID of the project the bypass belongs to.
    IsEnvVar bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    Note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    Secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    ProjectId string
    The ID of the project the bypass belongs to.
    IsEnvVar bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    Note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    Secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    project_id string
    The ID of the project the bypass belongs to.
    is_env_var bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    team_id string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId String
    The ID of the project the bypass belongs to.
    isEnvVar Boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note String
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    secret String
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId string
    The ID of the project the bypass belongs to.
    isEnvVar boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    project_id str
    The ID of the project the bypass belongs to.
    is_env_var bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note str
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    secret str
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    team_id str
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId String
    The ID of the project the bypass belongs to.
    isEnvVar Boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note String
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    secret String
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProjectProtectionBypass resource produces the following output properties:

    CreatedAt int
    The unix timestamp in milliseconds at which the bypass was created.
    CreatedBy string
    The ID of the user who created the bypass.
    Id string
    The provider-assigned unique ID for this managed resource.
    Scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    CreatedAt int
    The unix timestamp in milliseconds at which the bypass was created.
    CreatedBy string
    The ID of the user who created the bypass.
    Id string
    The provider-assigned unique ID for this managed resource.
    Scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    created_at number
    The unix timestamp in milliseconds at which the bypass was created.
    created_by string
    The ID of the user who created the bypass.
    id string
    The provider-assigned unique ID for this managed resource.
    scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    createdAt Integer
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy String
    The ID of the user who created the bypass.
    id String
    The provider-assigned unique ID for this managed resource.
    scope String
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    createdAt number
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy string
    The ID of the user who created the bypass.
    id string
    The provider-assigned unique ID for this managed resource.
    scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    created_at int
    The unix timestamp in milliseconds at which the bypass was created.
    created_by str
    The ID of the user who created the bypass.
    id str
    The provider-assigned unique ID for this managed resource.
    scope str
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    createdAt Number
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy String
    The ID of the user who created the bypass.
    id String
    The provider-assigned unique ID for this managed resource.
    scope String
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.

    Look up Existing ProjectProtectionBypass Resource

    Get an existing ProjectProtectionBypass resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProjectProtectionBypassState, opts?: CustomResourceOptions): ProjectProtectionBypass
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[int] = None,
        created_by: Optional[str] = None,
        is_env_var: Optional[bool] = None,
        note: Optional[str] = None,
        project_id: Optional[str] = None,
        scope: Optional[str] = None,
        secret: Optional[str] = None,
        team_id: Optional[str] = None) -> ProjectProtectionBypass
    func GetProjectProtectionBypass(ctx *Context, name string, id IDInput, state *ProjectProtectionBypassState, opts ...ResourceOption) (*ProjectProtectionBypass, error)
    public static ProjectProtectionBypass Get(string name, Input<string> id, ProjectProtectionBypassState? state, CustomResourceOptions? opts = null)
    public static ProjectProtectionBypass get(String name, Output<String> id, ProjectProtectionBypassState state, CustomResourceOptions options)
    resources:  _:    type: vercel:ProjectProtectionBypass    get:      id: ${id}
    import {
  to = vercel_project_protection_bypass.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt int
    The unix timestamp in milliseconds at which the bypass was created.
    CreatedBy string
    The ID of the user who created the bypass.
    IsEnvVar bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    Note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    ProjectId string
    The ID of the project the bypass belongs to.
    Scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    Secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    CreatedAt int
    The unix timestamp in milliseconds at which the bypass was created.
    CreatedBy string
    The ID of the user who created the bypass.
    IsEnvVar bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    Note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    ProjectId string
    The ID of the project the bypass belongs to.
    Scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    Secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    created_at number
    The unix timestamp in milliseconds at which the bypass was created.
    created_by string
    The ID of the user who created the bypass.
    is_env_var bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    project_id string
    The ID of the project the bypass belongs to.
    scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    team_id string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    createdAt Integer
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy String
    The ID of the user who created the bypass.
    isEnvVar Boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note String
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    projectId String
    The ID of the project the bypass belongs to.
    scope String
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    secret String
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    createdAt number
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy string
    The ID of the user who created the bypass.
    isEnvVar boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note string
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    projectId string
    The ID of the project the bypass belongs to.
    scope string
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    secret string
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    created_at int
    The unix timestamp in milliseconds at which the bypass was created.
    created_by str
    The ID of the user who created the bypass.
    is_env_var bool
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note str
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    project_id str
    The ID of the project the bypass belongs to.
    scope str
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    secret str
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    team_id str
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    createdAt Number
    The unix timestamp in milliseconds at which the bypass was created.
    createdBy String
    The ID of the user who created the bypass.
    isEnvVar Boolean
    Whether this bypass is exposed as the VERCEL_AUTOMATION_BYPASS_SECRET environment variable on deployments. Exactly one bypass per project may have this set to true; promoting a different bypass automatically demotes the previous one. Setting this to false when no other bypass on the project has is_env_var = true is invalid — Vercel requires exactly one default per project, and a solo bypass is always the default.
    note String
    An optional note shown in the Vercel UI for this bypass. Maximum 100 characters.
    projectId String
    The ID of the project the bypass belongs to.
    scope String
    The scope of the bypass. Always automation-bypass for bypasses managed by this resource.
    secret String
    The 32-character alphanumeric secret used as the value of the x-vercel-protection-bypass header. If omitted, Vercel generates one.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.

    Import

    The pulumi import command can be used, for example:

    If importing into a personal account, or with a team configured on the provider, use the project ID and bypass secret.

    • project_id can be found in the project settings tab in the Vercel UI.
    • secret is the 32-character bypass value (the map key under protectionBypass in the API).
    $ pulumi import vercel:index/projectProtectionBypass:ProjectProtectionBypass example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/abcdefghijklmnopqrstuvwxyz123456

    Alternatively, you can import via team_id, project_id, and the bypass secret.

    • team_id can be found in the team settings tab in the Vercel UI.
    $ pulumi import vercel:index/projectProtectionBypass:ProjectProtectionBypass example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/abcdefghijklmnopqrstuvwxyz123456

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Viewing docs for Vercel v5.4.1
    published on Wednesday, Jul 22, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-vercel

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial