Skip to main content
PATCH
/
v9
/
projects
/
{idOrName}
updateProject
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.updateProject({
    idOrName: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "a-project-name",
    },
  });

  console.log(result);
}

run();
{
  "accountId": "<string>",
  "directoryListing": true,
  "id": "<string>",
  "name": "<string>",
  "nodeVersion": "24.x",
  "resourceConfig": {
    "functionDefaultRegions": [
      "<string>"
    ],
    "fluid": true,
    "functionDefaultTimeout": 123,
    "functionDefaultMemoryType": "standard_legacy",
    "functionZeroConfigFailover": true,
    "elasticConcurrencyEnabled": true,
    "buildMachineType": "enhanced",
    "isNSNBDisabled": true
  },
  "defaultResourceConfig": {
    "functionDefaultRegions": [
      "<string>"
    ],
    "fluid": true,
    "functionDefaultTimeout": 123,
    "functionDefaultMemoryType": "standard_legacy",
    "functionZeroConfigFailover": true,
    "elasticConcurrencyEnabled": true,
    "buildMachineType": "enhanced",
    "isNSNBDisabled": true
  },
  "analytics": {
    "id": "<string>",
    "disabledAt": 123,
    "enabledAt": 123,
    "canceledAt": 123,
    "paidAt": 123,
    "sampleRatePercent": 123,
    "spendLimitInDollars": 123
  },
  "speedInsights": {
    "id": "<string>",
    "enabledAt": 123,
    "disabledAt": 123,
    "canceledAt": 123,
    "hasData": true,
    "paidAt": 123
  },
  "autoExposeSystemEnvs": true,
  "autoAssignCustomDomains": true,
  "autoAssignCustomDomainsUpdatedBy": "<string>",
  "buildCommand": "<string>",
  "commandForIgnoringBuildStep": "<string>",
  "connectConfigurations": [
    {
      "envId": "<string>",
      "connectConfigurationId": "<string>",
      "passive": true,
      "buildsEnabled": true,
      "createdAt": 123,
      "updatedAt": 123,
      "dc": "<string>",
      "aws": {
        "subnetIds": [
          "<string>"
        ],
        "securityGroupId": "<string>"
      }
    }
  ],
  "connectConfigurationId": "<string>",
  "connectBuildsEnabled": true,
  "passiveConnectConfigurationId": "<string>",
  "createdAt": 123,
  "customerSupportCodeVisibility": true,
  "crons": {
    "enabledAt": 123,
    "disabledAt": 123,
    "updatedAt": 123,
    "deploymentId": "<string>",
    "definitions": [
      {
        "host": "vercel.com",
        "path": "/api/crons/sync-something?hello=world",
        "schedule": "0 0 * * *"
      }
    ]
  },
  "dataCache": {
    "userDisabled": true,
    "storageSizeBytes": 123,
    "unlimited": true
  },
  "deploymentExpiration": {
    "expirationDays": 123,
    "expirationDaysProduction": 123,
    "expirationDaysCanceled": 123,
    "expirationDaysErrored": 123,
    "deploymentsToKeep": 123
  },
  "devCommand": "<string>",
  "installCommand": "<string>",
  "env": [
    {
      "type": "system",
      "value": "<string>",
      "key": "<string>",
      "target": [
        "<string>"
      ],
      "sunsetSecretId": "<string>",
      "decrypted": true,
      "vsmValue": "<string>",
      "id": "<string>",
      "configurationId": "<string>",
      "createdAt": 123,
      "updatedAt": 123,
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "gitBranch": "<string>",
      "edgeConfigId": "<string>",
      "edgeConfigTokenId": "<string>",
      "contentHint": {
        "type": "redis-url",
        "storeId": "<string>"
      },
      "internalContentHint": {
        "type": "flags-secret",
        "encryptedValue": "<string>"
      },
      "comment": "<string>",
      "customEnvironmentIds": [
        "<string>"
      ]
    }
  ],
  "customEnvironments": [
    {
      "id": "<string>",
      "slug": "<string>",
      "type": "preview",
      "createdAt": 123,
      "updatedAt": 123,
      "description": "<string>",
      "branchMatcher": {
        "type": "endsWith",
        "pattern": "<string>"
      },
      "domains": [
        {
          "name": "<string>",
          "apexName": "<string>",
          "projectId": "<string>",
          "verified": true,
          "redirect": "<string>",
          "redirectStatusCode": 307,
          "gitBranch": "<string>",
          "customEnvironmentId": "<string>",
          "updatedAt": 123,
          "createdAt": 123,
          "verification": [
            {
              "type": "<string>",
              "domain": "<string>",
              "value": "<string>",
              "reason": "<string>"
            }
          ]
        }
      ],
      "currentDeploymentAliases": [
        "<string>"
      ]
    }
  ],
  "framework": "blitzjs",
  "gitForkProtection": true,
  "gitLFS": true,
  "ipBuckets": [
    {
      "bucket": "<string>",
      "supportUntil": 123
    }
  ],
  "latestDeployments": [
    {
      "id": "<string>",
      "createdAt": 123,
      "createdIn": "<string>",
      "creator": {
        "email": "<string>",
        "uid": "<string>",
        "username": "<string>",
        "githubLogin": "<string>",
        "gitlabLogin": "<string>"
      },
      "deploymentHostname": "<string>",
      "name": "<string>",
      "plan": "pro",
      "private": true,
      "readyState": "BUILDING",
      "type": "LAMBDAS",
      "url": "<string>",
      "userId": "<string>",
      "alias": [
        "<string>"
      ],
      "aliasAssigned": 123,
      "aliasError": {
        "code": "<string>",
        "message": "<string>"
      },
      "aliasFinal": "<string>",
      "automaticAliases": [
        "<string>"
      ],
      "branchMatcher": {
        "type": "endsWith",
        "pattern": "<string>"
      },
      "buildingAt": 123,
      "builds": [
        {
          "use": "<string>",
          "src": "<string>",
          "dest": "<string>"
        }
      ],
      "checksConclusion": "succeeded",
      "checksState": "registered",
      "connectBuildsEnabled": true,
      "connectConfigurationId": "<string>",
      "deletedAt": 123,
      "forced": true,
      "meta": {},
      "monorepoManager": "<string>",
      "oidcTokenClaims": {
        "iss": "<string>",
        "sub": "<string>",
        "scope": "<string>",
        "aud": "<string>",
        "owner": "<string>",
        "owner_id": "<string>",
        "project": "<string>",
        "project_id": "<string>",
        "environment": "<string>",
        "plan": "<string>"
      },
      "previewCommentsEnabled": false,
      "readyAt": 123,
      "readySubstate": "STAGED",
      "requestedAt": 123,
      "target": "<string>",
      "teamId": "<string>",
      "withCache": true
    }
  ],
  "link": {
    "org": "<string>",
    "type": "github",
    "deployHooks": [
      {
        "id": "<string>",
        "name": "<string>",
        "ref": "<string>",
        "url": "<string>",
        "createdAt": 123
      }
    ],
    "gitCredentialId": "<string>",
    "productionBranch": "<string>",
    "repoOwnerId": 123,
    "repo": "<string>",
    "repoId": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "sourceless": true
  },
  "microfrontends": {
    "isDefaultApp": true,
    "updatedAt": 123,
    "groupIds": [
      "<string>"
    ],
    "enabled": true,
    "defaultRoute": "<string>",
    "freeProjectForLegacyLimits": true
  },
  "optionsAllowlist": {
    "paths": [
      {
        "value": "<string>"
      }
    ]
  },
  "outputDirectory": "<string>",
  "passwordProtection": {},
  "productionDeploymentsFastLane": true,
  "publicSource": true,
  "rollbackDescription": {
    "userId": "<string>",
    "username": "<string>",
    "description": "<string>",
    "createdAt": 123
  },
  "rollingRelease": {
    "target": "production",
    "stages": [
      {
        "targetPercentage": 25,
        "requireApproval": false,
        "duration": 600,
        "linearShift": false
      }
    ],
    "canaryResponseHeader": false
  },
  "rootDirectory": "<string>",
  "serverlessFunctionZeroConfigFailover": true,
  "skewProtectionBoundaryAt": 123,
  "skewProtectionMaxAge": 123,
  "skipGitConnectDuringLink": true,
  "staticIps": {
    "builds": true,
    "enabled": true,
    "regions": [
      "<string>"
    ]
  },
  "sourceFilesOutsideRootDirectory": true,
  "enableAffectedProjectsDeployments": true,
  "ssoProtection": {
    "deploymentType": "preview"
  },
  "targets": {},
  "transferCompletedAt": 123,
  "transferStartedAt": 123,
  "transferToAccountId": "<string>",
  "transferredFromAccountId": "<string>",
  "updatedAt": 123,
  "live": true,
  "enablePreviewFeedback": true,
  "enableProductionFeedback": true,
  "permissions": {
    "oauth2Connection": [
      "create"
    ],
    "user": [
      "create"
    ],
    "userConnection": [
      "create"
    ],
    "userSudo": [
      "create"
    ],
    "webAuthn": [
      "create"
    ],
    "accessGroup": [
      "create"
    ],
    "agent": [
      "create"
    ],
    "alerts": [
      "create"
    ],
    "alertRules": [
      "create"
    ],
    "aliasGlobal": [
      "create"
    ],
    "analyticsSampling": [
      "create"
    ],
    "analyticsUsage": [
      "create"
    ],
    "apiKey": [
      "create"
    ],
    "apiKeyAiGateway": [
      "create"
    ],
    "apiKeyOwnedBySelf": [
      "create"
    ],
    "oauth2Application": [
      "create"
    ],
    "vercelAppInstallation": [
      "create"
    ],
    "vercelAppInstallationRequest": [
      "create"
    ],
    "auditLog": [
      "create"
    ],
    "billingAddress": [
      "create"
    ],
    "billingInformation": [
      "create"
    ],
    "billingInvoice": [
      "create"
    ],
    "billingInvoiceEmailRecipient": [
      "create"
    ],
    "billingInvoiceLanguage": [
      "create"
    ],
    "billingPlan": [
      "create"
    ],
    "billingPurchaseOrder": [
      "create"
    ],
    "billingRefund": [
      "create"
    ],
    "billingTaxId": [
      "create"
    ],
    "blob": [
      "create"
    ],
    "blobStoreTokenSet": [
      "create"
    ],
    "budget": [
      "create"
    ],
    "cacheArtifact": [
      "create"
    ],
    "cacheArtifactUsageEvent": [
      "create"
    ],
    "codeChecks": [
      "create"
    ],
    "concurrentBuilds": [
      "create"
    ],
    "connect": [
      "create"
    ],
    "connectConfiguration": [
      "create"
    ],
    "dataCacheBillingSettings": [
      "create"
    ],
    "defaultDeploymentProtection": [
      "create"
    ],
    "domain": [
      "create"
    ],
    "domainAcceptDelegation": [
      "create"
    ],
    "domainAuthCodes": [
      "create"
    ],
    "domainCertificate": [
      "create"
    ],
    "domainCheckConfig": [
      "create"
    ],
    "domainMove": [
      "create"
    ],
    "domainPurchase": [
      "create"
    ],
    "domainRecord": [
      "create"
    ],
    "domainTransferIn": [
      "create"
    ],
    "drain": [
      "create"
    ],
    "edgeConfig": [
      "create"
    ],
    "edgeConfigItem": [
      "create"
    ],
    "edgeConfigSchema": [
      "create"
    ],
    "edgeConfigToken": [
      "create"
    ],
    "endpointVerification": [
      "create"
    ],
    "event": [
      "create"
    ],
    "fileUpload": [
      "create"
    ],
    "flagsExplorerSubscription": [
      "create"
    ],
    "gitRepository": [
      "create"
    ],
    "imageOptimizationNewPrice": [
      "create"
    ],
    "integration": [
      "create"
    ],
    "integrationAccount": [
      "create"
    ],
    "integrationConfiguration": [
      "create"
    ],
    "integrationConfigurationProjects": [
      "create"
    ],
    "integrationConfigurationRole": [
      "create"
    ],
    "integrationConfigurationTransfer": [
      "create"
    ],
    "integrationDeploymentAction": [
      "create"
    ],
    "integrationEvent": [
      "create"
    ],
    "integrationLog": [
      "create"
    ],
    "integrationResource": [
      "create"
    ],
    "integrationResourceReplCommand": [
      "create"
    ],
    "integrationResourceSecrets": [
      "create"
    ],
    "integrationSSOSession": [
      "create"
    ],
    "integrationStoreTokenSet": [
      "create"
    ],
    "integrationVercelConfigurationOverride": [
      "create"
    ],
    "integrationPullRequest": [
      "create"
    ],
    "ipBlocking": [
      "create"
    ],
    "jobGlobal": [
      "create"
    ],
    "logDrain": [
      "create"
    ],
    "marketplaceBillingData": [
      "create"
    ],
    "marketplaceExperimentationEdgeConfigData": [
      "create"
    ],
    "marketplaceExperimentationItem": [
      "create"
    ],
    "marketplaceInstallationMember": [
      "create"
    ],
    "marketplaceInvoice": [
      "create"
    ],
    "marketplaceSettings": [
      "create"
    ],
    "Monitoring": [
      "create"
    ],
    "monitoringAlert": [
      "create"
    ],
    "monitoringChart": [
      "create"
    ],
    "monitoringQuery": [
      "create"
    ],
    "monitoringSettings": [
      "create"
    ],
    "notificationCustomerBudget": [
      "create"
    ],
    "notificationDeploymentFailed": [
      "create"
    ],
    "notificationDomainConfiguration": [
      "create"
    ],
    "notificationDomainExpire": [
      "create"
    ],
    "notificationDomainMoved": [
      "create"
    ],
    "notificationDomainPurchase": [
      "create"
    ],
    "notificationDomainRenewal": [
      "create"
    ],
    "notificationDomainTransfer": [
      "create"
    ],
    "notificationDomainUnverified": [
      "create"
    ],
    "NotificationMonitoringAlert": [
      "create"
    ],
    "notificationPaymentFailed": [
      "create"
    ],
    "notificationPreferences": [
      "create"
    ],
    "notificationStatementOfReasons": [
      "create"
    ],
    "notificationUsageAlert": [
      "create"
    ],
    "observabilityConfiguration": [
      "create"
    ],
    "observabilityFunnel": [
      "create"
    ],
    "observabilityNotebook": [
      "create"
    ],
    "openTelemetryEndpoint": [
      "create"
    ],
    "ownEvent": [
      "create"
    ],
    "organizationDomain": [
      "create"
    ],
    "passwordProtectionInvoiceItem": [
      "create"
    ],
    "paymentMethod": [
      "create"
    ],
    "permissions": [
      "create"
    ],
    "postgres": [
      "create"
    ],
    "postgresStoreTokenSet": [
      "create"
    ],
    "previewDeploymentSuffix": [
      "create"
    ],
    "projectTransferIn": [
      "create"
    ],
    "proTrialOnboarding": [
      "create"
    ],
    "rateLimit": [
      "create"
    ],
    "redis": [
      "create"
    ],
    "redisStoreTokenSet": [
      "create"
    ],
    "remoteCaching": [
      "create"
    ],
    "repository": [
      "create"
    ],
    "samlConfig": [
      "create"
    ],
    "secret": [
      "create"
    ],
    "securityPlusConfiguration": [
      "create"
    ],
    "sensitiveEnvironmentVariablePolicy": [
      "create"
    ],
    "sharedEnvVars": [
      "create"
    ],
    "sharedEnvVarsProduction": [
      "create"
    ],
    "space": [
      "create"
    ],
    "spaceRun": [
      "create"
    ],
    "storeTransfer": [
      "create"
    ],
    "supportCase": [
      "create"
    ],
    "supportCaseComment": [
      "create"
    ],
    "team": [
      "create"
    ],
    "teamAccessRequest": [
      "create"
    ],
    "teamFellowMembership": [
      "create"
    ],
    "teamGitExclusivity": [
      "create"
    ],
    "teamInvite": [
      "create"
    ],
    "teamInviteCode": [
      "create"
    ],
    "teamJoin": [
      "create"
    ],
    "teamMemberMfaStatus": [
      "create"
    ],
    "teamMicrofrontends": [
      "create"
    ],
    "teamOwnMembership": [
      "create"
    ],
    "teamOwnMembershipDisconnectSAML": [
      "create"
    ],
    "token": [
      "create"
    ],
    "usage": [
      "create"
    ],
    "usageCycle": [
      "create"
    ],
    "vercelRun": [
      "create"
    ],
    "vercelRunExec": [
      "create"
    ],
    "vpcPeeringConnection": [
      "create"
    ],
    "webAnalyticsPlan": [
      "create"
    ],
    "webhook": [
      "create"
    ],
    "webhook-event": [
      "create"
    ],
    "aliasProject": [
      "create"
    ],
    "aliasProtectionBypass": [
      "create"
    ],
    "buildMachine": [
      "create"
    ],
    "connectConfigurationLink": [
      "create"
    ],
    "dataCacheNamespace": [
      "create"
    ],
    "deployment": [
      "create"
    ],
    "deploymentBuildLogs": [
      "create"
    ],
    "deploymentCheck": [
      "create"
    ],
    "deploymentCheckPreview": [
      "create"
    ],
    "deploymentCheckReRunFromProductionBranch": [
      "create"
    ],
    "deploymentProductionGit": [
      "create"
    ],
    "deploymentV0": [
      "create"
    ],
    "deploymentPreview": [
      "create"
    ],
    "deploymentPrivate": [
      "create"
    ],
    "deploymentPromote": [
      "create"
    ],
    "deploymentRollback": [
      "create"
    ],
    "edgeCacheNamespace": [
      "create"
    ],
    "environments": [
      "create"
    ],
    "job": [
      "create"
    ],
    "logs": [
      "create"
    ],
    "logsPreset": [
      "create"
    ],
    "observabilityData": [
      "create"
    ],
    "onDemandBuild": [
      "create"
    ],
    "onDemandConcurrency": [
      "create"
    ],
    "optionsAllowlist": [
      "create"
    ],
    "passwordProtection": [
      "create"
    ],
    "productionAliasProtectionBypass": [
      "create"
    ],
    "project": [
      "create"
    ],
    "projectAccessGroup": [
      "create"
    ],
    "projectAnalyticsSampling": [
      "create"
    ],
    "projectAnalyticsUsage": [
      "create"
    ],
    "projectCheck": [
      "create"
    ],
    "projectCheckRun": [
      "create"
    ],
    "projectDeploymentExpiration": [
      "create"
    ],
    "projectDeploymentHook": [
      "create"
    ],
    "projectDomain": [
      "create"
    ],
    "projectDomainCheckConfig": [
      "create"
    ],
    "projectDomainMove": [
      "create"
    ],
    "projectEnvVars": [
      "create"
    ],
    "projectEnvVarsProduction": [
      "create"
    ],
    "projectEnvVarsUnownedByIntegration": [
      "create"
    ],
    "projectFlags": [
      "create"
    ],
    "projectFlagsProduction": [
      "create"
    ],
    "projectFromV0": [
      "create"
    ],
    "projectId": [
      "create"
    ],
    "projectIntegrationConfiguration": [
      "create"
    ],
    "projectLink": [
      "create"
    ],
    "projectMember": [
      "create"
    ],
    "projectMonitoring": [
      "create"
    ],
    "projectOIDCToken": [
      "create"
    ],
    "projectPermissions": [
      "create"
    ],
    "projectProductionBranch": [
      "create"
    ],
    "projectProtectionBypass": [
      "create"
    ],
    "projectRollingRelease": [
      "create"
    ],
    "projectSupportCase": [
      "create"
    ],
    "projectSupportCaseComment": [
      "create"
    ],
    "projectTier": [
      "create"
    ],
    "projectTransfer": [
      "create"
    ],
    "projectTransferOut": [
      "create"
    ],
    "projectUsage": [
      "create"
    ],
    "seawallConfig": [
      "create"
    ],
    "sharedEnvVarConnection": [
      "create"
    ],
    "skewProtection": [
      "create"
    ],
    "analytics": [
      "create"
    ],
    "trustedIps": [
      "create"
    ],
    "v0Chat": [
      "create"
    ],
    "webAnalytics": [
      "create"
    ]
  },
  "lastRollbackTarget": {},
  "lastAliasRequest": {
    "fromDeploymentId": "<string>",
    "toDeploymentId": "<string>",
    "jobStatus": "succeeded",
    "requestedAt": 123,
    "type": "promote",
    "fromRollingReleaseId": "<string>"
  },
  "protectionBypass": {},
  "hasActiveBranches": true,
  "trustedIps": {
    "deploymentType": "preview",
    "addresses": [
      {
        "value": "<string>",
        "note": "<string>"
      }
    ],
    "protectionMode": "additional"
  },
  "gitComments": {
    "onPullRequest": true,
    "onCommit": true
  },
  "gitProviderOptions": {
    "createDeployments": "enabled",
    "disableRepositoryDispatchEvents": true,
    "requireVerifiedCommits": true
  },
  "paused": true,
  "concurrencyBucketName": "<string>",
  "webAnalytics": {
    "id": "<string>",
    "disabledAt": 123,
    "canceledAt": 123,
    "enabledAt": 123,
    "hasData": true
  },
  "security": {
    "attackModeEnabled": true,
    "attackModeUpdatedAt": 123,
    "firewallEnabled": true,
    "firewallUpdatedAt": 123,
    "attackModeActiveUntil": 123,
    "firewallConfigVersion": 123,
    "firewallSeawallEnabled": true,
    "ja3Enabled": true,
    "ja4Enabled": true,
    "firewallBypassIps": [
      "<string>"
    ],
    "managedRules": {
      "bot_filter": {
        "active": true,
        "action": "log"
      },
      "ai_bots": {
        "active": true,
        "action": "log"
      },
      "owasp": {
        "active": true,
        "action": "log"
      }
    },
    "botIdEnabled": true
  },
  "oidcTokenConfig": {
    "enabled": true,
    "issuerMode": "team"
  },
  "tier": "standard",
  "features": {
    "webAnalytics": true
  },
  "v0": true,
  "abuse": {
    "history": [
      {
        "scanner": "<string>",
        "reason": "<string>",
        "by": "<string>",
        "byId": "<string>",
        "at": 123
      }
    ],
    "updatedAt": 123,
    "scanner": "<string>",
    "block": {
      "action": "blocked",
      "reason": "<string>",
      "statusCode": 123,
      "createdAt": 123,
      "caseId": "<string>",
      "actor": "<string>",
      "comment": "<string>",
      "isCascading": true
    },
    "blockHistory": [
      {
        "action": "blocked",
        "reason": "<string>",
        "statusCode": 123,
        "createdAt": 123,
        "caseId": "<string>",
        "actor": "<string>",
        "comment": "<string>",
        "isCascading": true
      }
    ],
    "interstitial": true
  },
  "internalRoutes": [
    {
      "src": "<string>",
      "status": 123
    }
  ],
  "hasDeployments": true,
  "dismissedToasts": [
    {
      "key": "<string>",
      "dismissedAt": 123,
      "action": "cancel",
      "value": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The unique project identifier or the project name

Example:

"prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"

Query Parameters

​
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
​
autoExposeSystemEnvs
boolean
​
autoAssignCustomDomains
boolean
​
autoAssignCustomDomainsUpdatedBy
string
​
buildCommand
string | null

The build command for this project. When null is used this value will be automatically detected

Maximum string length: 256
​
commandForIgnoringBuildStep
string | null
Maximum string length: 256
​
customerSupportCodeVisibility
boolean

Specifies whether customer support can see git source for a deployment

​
devCommand
string | null

The dev command for this project. When null is used this value will be automatically detected

Maximum string length: 256
​
directoryListing
boolean
​
framework
enum<string> | null

The framework that is being used for this project. When null is used no framework is selected

Available options:
,
blitzjs,
nextjs,
gatsby,
remix,
react-router,
astro,
hexo,
eleventy,
docusaurus-2,
docusaurus,
preact,
solidstart-1,
solidstart,
dojo,
ember,
vue,
scully,
ionic-angular,
angular,
polymer,
svelte,
sveltekit,
sveltekit-1,
ionic-react,
create-react-app,
gridsome,
umijs,
sapper,
saber,
stencil,
nuxtjs,
redwoodjs,
hugo,
jekyll,
brunch,
middleman,
zola,
hydrogen,
vite,
tanstack-start,
vitepress,
vuepress,
parcel,
fastapi,
flask,
fasthtml,
sanity-v3,
sanity,
storybook,
nitro,
hono,
express,
h3,
nestjs,
elysia,
fastify,
xmcp
​
gitForkProtection
boolean

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

​
gitLFS
boolean

Specifies whether Git LFS is enabled for this project.

​
installCommand
string | null

The install command for this project. When null is used this value will be automatically detected

Maximum string length: 256
​
name
string

The desired name for the project

Maximum string length: 100
Example:

"a-project-name"

​
nodeVersion
enum<string>
Available options:
24.x,
22.x,
20.x,
18.x,
16.x,
14.x,
12.x,
10.x
​
outputDirectory
string | null

The output directory of the project. When null is used this value will be automatically detected

Maximum string length: 256
​
previewDeploymentsDisabled
boolean | null

Specifies whether preview deployments are disabled for this project.

​
previewDeploymentSuffix
string | null

Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team.

Maximum string length: 253
​
publicSource
boolean | null

Specifies whether the source code and logs of the deployments for this project should be public or not

​
resourceConfig
object

Specifies resource override configuration for the project

​
rootDirectory
string | null

The name of a directory or relative path to the source code of your project. When null is used it will default to the project root

Maximum string length: 256
​
serverlessFunctionRegion
string | null

The region to deploy Serverless Functions in this project

Maximum string length: 4
​
serverlessFunctionZeroConfigFailover
boolean

Specifies whether Zero Config Failover is enabled for this project.

​
skewProtectionBoundaryAt
integer

Deployments created before this absolute datetime have Skew Protection disabled. Value is in milliseconds since epoch to match "createdAt" fields.

Required range: x >= 0
​
skewProtectionMaxAge
integer

Deployments created before this rolling window have Skew Protection disabled. Value is in seconds to match "revalidate" fields.

Required range: x >= 0
​
skipGitConnectDuringLink
boolean
deprecated

Opts-out of the message prompting a CLI user to connect a Git repository in vercel link.

​
sourceFilesOutsideRootDirectory
boolean

Indicates if there are source files outside of the root directory

​
enablePreviewFeedback
boolean | null

Opt-in to preview toolbar on the project level

​
enableProductionFeedback
boolean | null

Opt-in to production toolbar on the project level

​
enableAffectedProjectsDeployments
boolean

Opt-in to skip deployments when there are no changes to the root directory and its dependencies

​
staticIps
object

Manage Static IPs for this project

​
oidcTokenConfig
object

OpenID Connect JSON Web Token generation configuration.

​
passwordProtection
object

Allows to protect project deployments with a password

​
ssoProtection
object

Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team

​
trustedIps
object

Restricts access to deployments based on the incoming request IP address

​
optionsAllowlist
object

Specify a list of paths that should not be protected by Deployment Protection to enable Cors preflight requests

​
connectConfigurations
object[] | null

The list of connections from project environment to Secure Compute network

Minimum array length: 1
​
dismissedToasts
object[]

An array of objects representing a Dismissed Toast in regards to a Project. Objects are either merged with existing toasts (on key match), or added to the dimissedToasts array.`

Maximum array length: 50

Response

The project was successfully updated

​
accountId
string
required
​
directoryListing
boolean
required
​
id
string
required
​
name
string
required
​
nodeVersion
enum<string>
required
Available options:
24.x,
22.x,
20.x,
18.x,
16.x,
14.x,
12.x,
10.x,
8.10.x
​
resourceConfig
object
required
​
defaultResourceConfig
object
required
​
analytics
object
​
speedInsights
object
​
autoExposeSystemEnvs
boolean
​
autoAssignCustomDomains
boolean
​
autoAssignCustomDomainsUpdatedBy
string
​
buildCommand
string | null
​
commandForIgnoringBuildStep
string | null
​
connectConfigurations
object[] | null
​
connectConfigurationId
string | null
​
connectBuildsEnabled
boolean
​
passiveConnectConfigurationId
string | null
​
createdAt
number
​
customerSupportCodeVisibility
boolean
​
crons
object
​
dataCache
object
​
deploymentExpiration
object

Retention policies for deployments. These are enforced at the project level, but we also maintain an instance of this at the team level as a default policy that gets applied to new projects.

​
devCommand
string | null
​
installCommand
string | null
​
env
object[]
​
customEnvironments
object[]
​
framework
enum<string> | null
Available options:
blitzjs,
nextjs,
gatsby,
remix,
react-router,
astro,
hexo,
eleventy,
docusaurus-2,
docusaurus,
preact,
solidstart-1,
solidstart,
dojo,
ember,
vue,
scully,
ionic-angular,
angular,
polymer,
svelte,
sveltekit,
sveltekit-1,
ionic-react,
create-react-app,
gridsome,
umijs,
sapper,
saber,
stencil,
nuxtjs,
redwoodjs,
hugo,
jekyll,
brunch,
middleman,
zola,
hydrogen,
vite,
tanstack-start,
vitepress,
vuepress,
parcel,
fastapi,
flask,
fasthtml,
sanity-v3,
sanity,
storybook,
nitro,
hono,
express,
h3,
nestjs,
elysia,
fastify,
xmcp
​
gitForkProtection
boolean
​
gitLFS
boolean
​
ipBuckets
object[]
​
latestDeployments
object[]
​
link
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
​
microfrontends
object
  • Option 1
  • Option 2
  • Option 3
​
optionsAllowlist
object
​
outputDirectory
string | null
​
passwordProtection
object
​
productionDeploymentsFastLane
boolean
​
publicSource
boolean | null
​
rollbackDescription
object

Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback.

​
rollingRelease
object

Project-level rolling release configuration that defines how deployments should be gradually rolled out

​
rootDirectory
string | null
​
serverlessFunctionZeroConfigFailover
boolean
​
skewProtectionBoundaryAt
number
​
skewProtectionMaxAge
number
​
skipGitConnectDuringLink
boolean
​
staticIps
object
​
sourceFilesOutsideRootDirectory
boolean
​
enableAffectedProjectsDeployments
boolean
​
ssoProtection
object
​
targets
object
​
transferCompletedAt
number
​
transferStartedAt
number
​
transferToAccountId
string
​
transferredFromAccountId
string
​
updatedAt
number
​
live
boolean
​
enablePreviewFeedback
boolean | null
​
enableProductionFeedback
boolean | null
​
permissions
object
​
lastRollbackTarget
object
​
lastAliasRequest
object
​
protectionBypass
object
​
hasActiveBranches
boolean
​
trustedIps
object
  • Option 1
  • Option 2
​
gitComments
object
​
gitProviderOptions
object
​
paused
boolean
​
concurrencyBucketName
string
​
webAnalytics
object
​
security
object
​
oidcTokenConfig
object
​
tier
enum<string>
Available options:
standard,
advanced,
critical
​
features
object
​
v0
boolean
​
abuse
object
​
internalRoutes
object[]
  • Option 1
  • Option 2
​
hasDeployments
boolean
​
dismissedToasts
object[]