Vercel v1.15.0 published on Wednesday, Mar 19, 2025 by Pulumiverse
vercel.getProject
Explore with Pulumi AI
Using getProject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
def get_project(name: Optional[str] = None,
team_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(name: Optional[pulumi.Input[str]] = None,
team_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
> Note: This function is named LookupProject
in the Go SDK.
public static class GetProject
{
public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
fn::invoke:
function: vercel:index/getProject:getProject
arguments:
# arguments dictionary
The following arguments are supported:
getProject Result
The following output properties are available:
- Auto
Assign boolCustom Domains - Automatically
Expose boolSystem Environment Variables - Build
Command string - Customer
Success boolCode Visibility - Dev
Command string - Directory
Listing bool - Environments
List<Pulumiverse.
Vercel. Outputs. Get Project Environment> - Framework string
- Function
Failover bool - Git
Comments Pulumiverse.Vercel. Outputs. Get Project Git Comments - Git
Fork boolProtection - Git
Lfs bool - Git
Repository Pulumiverse.Vercel. Outputs. Get Project Git Repository - Id string
- Ignore
Command string - Install
Command string - Name string
- Oidc
Token Pulumiverse.Config Vercel. Outputs. Get Project Oidc Token Config - Options
Allowlist Pulumiverse.Vercel. Outputs. Get Project Options Allowlist - Output
Directory string - Password
Protection Pulumiverse.Vercel. Outputs. Get Project Password Protection - Preview
Comments bool - Prioritise
Production boolBuilds - Protection
Bypass boolFor Automation - Protection
Bypass stringFor Automation Secret - Public
Source bool - Resource
Config Pulumiverse.Vercel. Outputs. Get Project Resource Config - Root
Directory string - Serverless
Function stringRegion - Skew
Protection string - Team
Id string - Trusted
Ips Pulumiverse.Vercel. Outputs. Get Project Trusted Ips - Vercel
Authentication Pulumiverse.Vercel. Outputs. Get Project Vercel Authentication
- Auto
Assign boolCustom Domains - Automatically
Expose boolSystem Environment Variables - Build
Command string - Customer
Success boolCode Visibility - Dev
Command string - Directory
Listing bool - Environments
[]Get
Project Environment - Framework string
- Function
Failover bool - Git
Comments GetProject Git Comments - Git
Fork boolProtection - Git
Lfs bool - Git
Repository GetProject Git Repository - Id string
- Ignore
Command string - Install
Command string - Name string
- Oidc
Token GetConfig Project Oidc Token Config - Options
Allowlist GetProject Options Allowlist - Output
Directory string - Password
Protection GetProject Password Protection - Preview
Comments bool - Prioritise
Production boolBuilds - Protection
Bypass boolFor Automation - Protection
Bypass stringFor Automation Secret - Public
Source bool - Resource
Config GetProject Resource Config - Root
Directory string - Serverless
Function stringRegion - Skew
Protection string - Team
Id string - Trusted
Ips GetProject Trusted Ips - Vercel
Authentication GetProject Vercel Authentication
- auto
Assign BooleanCustom Domains - automatically
Expose BooleanSystem Environment Variables - build
Command String - customer
Success BooleanCode Visibility - dev
Command String - directory
Listing Boolean - environments
List<Get
Project Environment> - framework String
- function
Failover Boolean - git
Comments GetProject Git Comments - git
Fork BooleanProtection - git
Lfs Boolean - git
Repository GetProject Git Repository - id String
- ignore
Command String - install
Command String - name String
- oidc
Token GetConfig Project Oidc Token Config - options
Allowlist GetProject Options Allowlist - output
Directory String - password
Protection GetProject Password Protection - preview
Comments Boolean - prioritise
Production BooleanBuilds - protection
Bypass BooleanFor Automation - protection
Bypass StringFor Automation Secret - public
Source Boolean - resource
Config GetProject Resource Config - root
Directory String - serverless
Function StringRegion - skew
Protection String - team
Id String - trusted
Ips GetProject Trusted Ips - vercel
Authentication GetProject Vercel Authentication
- auto
Assign booleanCustom Domains - automatically
Expose booleanSystem Environment Variables - build
Command string - customer
Success booleanCode Visibility - dev
Command string - directory
Listing boolean - environments
Get
Project Environment[] - framework string
- function
Failover boolean - git
Comments GetProject Git Comments - git
Fork booleanProtection - git
Lfs boolean - git
Repository GetProject Git Repository - id string
- ignore
Command string - install
Command string - name string
- oidc
Token GetConfig Project Oidc Token Config - options
Allowlist GetProject Options Allowlist - output
Directory string - password
Protection GetProject Password Protection - preview
Comments boolean - prioritise
Production booleanBuilds - protection
Bypass booleanFor Automation - protection
Bypass stringFor Automation Secret - public
Source boolean - resource
Config GetProject Resource Config - root
Directory string - serverless
Function stringRegion - skew
Protection string - team
Id string - trusted
Ips GetProject Trusted Ips - vercel
Authentication GetProject Vercel Authentication
- auto_
assign_ boolcustom_ domains - automatically_
expose_ boolsystem_ environment_ variables - build_
command str - customer_
success_ boolcode_ visibility - dev_
command str - directory_
listing bool - environments
Sequence[Get
Project Environment] - framework str
- function_
failover bool - git_
comments GetProject Git Comments - git_
fork_ boolprotection - git_
lfs bool - git_
repository GetProject Git Repository - id str
- ignore_
command str - install_
command str - name str
- oidc_
token_ Getconfig Project Oidc Token Config - options_
allowlist GetProject Options Allowlist - output_
directory str - password_
protection GetProject Password Protection - preview_
comments bool - prioritise_
production_ boolbuilds - protection_
bypass_ boolfor_ automation - protection_
bypass_ strfor_ automation_ secret - public_
source bool - resource_
config GetProject Resource Config - root_
directory str - serverless_
function_ strregion - skew_
protection str - team_
id str - trusted_
ips GetProject Trusted Ips - vercel_
authentication GetProject Vercel Authentication
- auto
Assign BooleanCustom Domains - automatically
Expose BooleanSystem Environment Variables - build
Command String - customer
Success BooleanCode Visibility - dev
Command String - directory
Listing Boolean - environments List<Property Map>
- framework String
- function
Failover Boolean - git
Comments Property Map - git
Fork BooleanProtection - git
Lfs Boolean - git
Repository Property Map - id String
- ignore
Command String - install
Command String - name String
- oidc
Token Property MapConfig - options
Allowlist Property Map - output
Directory String - password
Protection Property Map - preview
Comments Boolean - prioritise
Production BooleanBuilds - protection
Bypass BooleanFor Automation - protection
Bypass StringFor Automation Secret - public
Source Boolean - resource
Config Property Map - root
Directory String - serverless
Function StringRegion - skew
Protection String - team
Id String - trusted
Ips Property Map - vercel
Authentication Property Map
Supporting Types
GetProjectEnvironment
- Comment string
- A comment explaining what the environment variable is for.
- Custom
Environment List<string>Ids - The IDs of Custom Environments that the Environment Variable should be present on.
- Git
Branch string - The git branch of the environment variable.
- Id string
- The ID of the environment variable
- Key string
- The name of the environment variable.
- Sensitive bool
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - Targets List<string>
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - Value string
- The value of the environment variable.
- Comment string
- A comment explaining what the environment variable is for.
- Custom
Environment []stringIds - The IDs of Custom Environments that the Environment Variable should be present on.
- Git
Branch string - The git branch of the environment variable.
- Id string
- The ID of the environment variable
- Key string
- The name of the environment variable.
- Sensitive bool
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - Targets []string
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - Value string
- The value of the environment variable.
- comment String
- A comment explaining what the environment variable is for.
- custom
Environment List<String>Ids - The IDs of Custom Environments that the Environment Variable should be present on.
- git
Branch String - The git branch of the environment variable.
- id String
- The ID of the environment variable
- key String
- The name of the environment variable.
- sensitive Boolean
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - targets List<String>
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - value String
- The value of the environment variable.
- comment string
- A comment explaining what the environment variable is for.
- custom
Environment string[]Ids - The IDs of Custom Environments that the Environment Variable should be present on.
- git
Branch string - The git branch of the environment variable.
- id string
- The ID of the environment variable
- key string
- The name of the environment variable.
- sensitive boolean
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - targets string[]
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - value string
- The value of the environment variable.
- comment str
- A comment explaining what the environment variable is for.
- custom_
environment_ Sequence[str]ids - The IDs of Custom Environments that the Environment Variable should be present on.
- git_
branch str - The git branch of the environment variable.
- id str
- The ID of the environment variable
- key str
- The name of the environment variable.
- sensitive bool
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - targets Sequence[str]
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - value str
- The value of the environment variable.
- comment String
- A comment explaining what the environment variable is for.
- custom
Environment List<String>Ids - The IDs of Custom Environments that the Environment Variable should be present on.
- git
Branch String - The git branch of the environment variable.
- id String
- The ID of the environment variable
- key String
- The name of the environment variable.
- sensitive Boolean
- Whether the Environment Variable is sensitive or not. Note that the value will be
null
for sensitive environment variables. - targets List<String>
- The environments that the environment variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. - value String
- The value of the environment variable.
GetProjectGitComments
- On
Commit bool - Whether Commit comments are enabled
- On
Pull boolRequest - Whether Pull Request comments are enabled
- On
Commit bool - Whether Commit comments are enabled
- On
Pull boolRequest - Whether Pull Request comments are enabled
- on
Commit Boolean - Whether Commit comments are enabled
- on
Pull BooleanRequest - Whether Pull Request comments are enabled
- on
Commit boolean - Whether Commit comments are enabled
- on
Pull booleanRequest - Whether Pull Request comments are enabled
- on_
commit bool - Whether Commit comments are enabled
- on_
pull_ boolrequest - Whether Pull Request comments are enabled
- on
Commit Boolean - Whether Commit comments are enabled
- on
Pull BooleanRequest - Whether Pull Request comments are enabled
GetProjectGitRepository
- Deploy
Hooks List<Pulumiverse.Vercel. Inputs. Get Project Git Repository Deploy Hook> - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- Production
Branch string - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- Repo string
- The name of the git repository. For example:
vercel/next.js
. - Type string
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
- Deploy
Hooks []GetProject Git Repository Deploy Hook - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- Production
Branch string - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- Repo string
- The name of the git repository. For example:
vercel/next.js
. - Type string
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
- deploy
Hooks List<GetProject Git Repository Deploy Hook> - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- production
Branch String - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- repo String
- The name of the git repository. For example:
vercel/next.js
. - type String
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
- deploy
Hooks GetProject Git Repository Deploy Hook[] - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- production
Branch string - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- repo string
- The name of the git repository. For example:
vercel/next.js
. - type string
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
- deploy_
hooks Sequence[GetProject Git Repository Deploy Hook] - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- production_
branch str - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- repo str
- The name of the git repository. For example:
vercel/next.js
. - type str
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
- deploy
Hooks List<Property Map> - Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
- production
Branch String - By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
- repo String
- The name of the git repository. For example:
vercel/next.js
. - type String
- The git provider of the repository. Must be either
github
,gitlab
, orbitbucket
.
GetProjectGitRepositoryDeployHook
GetProjectOidcTokenConfig
- Enabled bool
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- Issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- Enabled bool
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- Issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- enabled Boolean
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- issuer
Mode String - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- enabled boolean
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- enabled bool
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- issuer_
mode str - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- enabled Boolean
- When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
- issuer
Mode String - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
GetProjectOptionsAllowlist
- Paths
List<Pulumiverse.
Vercel. Inputs. Get Project Options Allowlist Path> - The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
- Paths
[]Get
Project Options Allowlist Path - The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
- paths
List<Get
Project Options Allowlist Path> - The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
- paths
Get
Project Options Allowlist Path[] - The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
- paths
Sequence[Get
Project Options Allowlist Path] - The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
- paths List<Property Map>
- The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONS
and start with one of the path values.
GetProjectOptionsAllowlistPath
- Value string
- Value string
- value String
- value string
- value str
- value String
GetProjectPasswordProtection
- Deployment
Type string - The deployment environment that will be protected.
- Deployment
Type string - The deployment environment that will be protected.
- deployment
Type String - The deployment environment that will be protected.
- deployment
Type string - The deployment environment that will be protected.
- deployment_
type str - The deployment environment that will be protected.
- deployment
Type String - The deployment environment that will be protected.
GetProjectResourceConfig
- Function
Default stringCpu Type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- Function
Default intTimeout - The default timeout for Serverless Functions.
- Function
Default stringCpu Type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- Function
Default intTimeout - The default timeout for Serverless Functions.
- function
Default StringCpu Type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- function
Default IntegerTimeout - The default timeout for Serverless Functions.
- function
Default stringCpu Type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- function
Default numberTimeout - The default timeout for Serverless Functions.
- function_
default_ strcpu_ type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- function_
default_ inttimeout - The default timeout for Serverless Functions.
- function
Default StringCpu Type - The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
- function
Default NumberTimeout - The default timeout for Serverless Functions.
GetProjectTrustedIps
- Addresses
List<Pulumiverse.
Vercel. Inputs. Get Project Trusted Ips Address> - The allowed IP addressses and CIDR ranges with optional descriptions.
- Deployment
Type string - The deployment environment that will be protected.
- Protection
Mode string - Whether or not Trusted IPs is required or optional to access a deployment.
- Addresses
[]Get
Project Trusted Ips Address - The allowed IP addressses and CIDR ranges with optional descriptions.
- Deployment
Type string - The deployment environment that will be protected.
- Protection
Mode string - Whether or not Trusted IPs is required or optional to access a deployment.
- addresses
List<Get
Project Trusted Ips Address> - The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment
Type String - The deployment environment that will be protected.
- protection
Mode String - Whether or not Trusted IPs is required or optional to access a deployment.
- addresses
Get
Project Trusted Ips Address[] - The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment
Type string - The deployment environment that will be protected.
- protection
Mode string - Whether or not Trusted IPs is required or optional to access a deployment.
- addresses
Sequence[Get
Project Trusted Ips Address] - The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment_
type str - The deployment environment that will be protected.
- protection_
mode str - Whether or not Trusted IPs is required or optional to access a deployment.
- addresses List<Property Map>
- The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment
Type String - The deployment environment that will be protected.
- protection
Mode String - Whether or not Trusted IPs is required or optional to access a deployment.
GetProjectTrustedIpsAddress
GetProjectVercelAuthentication
- Deployment
Type string - The deployment environment that will be protected.
- Deployment
Type string - The deployment environment that will be protected.
- deployment
Type String - The deployment environment that will be protected.
- deployment
Type string - The deployment environment that will be protected.
- deployment_
type str - The deployment environment that will be protected.
- deployment
Type String - The deployment environment that will be protected.
Package Details
- Repository
- vercel pulumiverse/pulumi-vercel
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vercel
Terraform Provider.