Skip to main content

projects

Overview

Nameprojects
TypeResource
Idvercel.projects.projects

Fields

NameDatatype
idstring
namestring
accountIdstring
analyticsobject
autoAssignCustomDomainsboolean
autoAssignCustomDomainsUpdatedBystring
autoExposeSystemEnvsboolean
buildCommandstring
commandForIgnoringBuildStepstring
connectBuildsEnabledboolean
connectConfigurationIdstring
createdAtnumber
cronsobject
customerSupportCodeVisibilityboolean
dataCacheobject
devCommandstring
directoryListingboolean
enablePreviewFeedbackboolean
envarray
frameworkstring
gitCommentsobject
gitForkProtectionboolean
gitLFSboolean
hasActiveBranchesboolean
hasFloatingAliasesboolean
installCommandstring
lastAliasRequestobject
lastRollbackTargetobject
latestDeploymentsarray
link
liveboolean
nodeVersionstring
outputDirectorystring
passwordProtectionobject
pausedboolean
permissionsobject
productionDeploymentsFastLaneboolean
protectionBypassobject
publicSourceboolean
rootDirectorystring
serverlessFunctionRegionstring
skipGitConnectDuringLinkboolean
sourceFilesOutsideRootDirectoryboolean
ssoProtectionobject
targetsobject
transferCompletedAtnumber
transferStartedAtnumber
transferToAccountIdstring
transferredFromAccountIdstring
trustedIps
updatedAtnumber

Methods

NameAccessible byRequired ParamsDescription
get_projectSELECTidOrName, teamIdGet the information for a specific project by passing either the project id or name in the URL.
get_projectsSELECTteamIdAllows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.
create_projectINSERTteamId, data__nameAllows to create a new project with the provided configuration. It only requires the project name but more configuration can be provided to override the defaults.
delete_projectDELETEidOrName, teamIdDelete a specific project by passing either the project id or name in the URL.
_get_projectsEXECteamIdAllows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.
update_projectEXECidOrName, teamIdUpdate the fields of a project using either its name or id.
update_project_data_cacheEXECprojectId, teamIdUpdate the data cache feature on a project.