Skip to content
Docs

Create a new project

POSThttps://api.vercel.com/v11/projects
Allows 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.
https://api.vercel.com/v11/projects
const response = await fetch('https://api.vercel.com/v11/projects?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "enablePreviewFeedback": "true",
    "enableProductionFeedback": "true",
    "previewDeploymentsDisabled": "true",
    "previewDeploymentSuffix": "string",
    "buildCommand": "string",
    "commandForIgnoringBuildStep": "string",
    "devCommand": "string",
    "environmentVariables": [
      {
        "key": "string",
        "target": "production",
        "gitBranch": "string",
        "type": "system",
        "value": "string"
      }
    ],
    "framework": "null",
    "gitRepository": {
      "repo": "string",
      "type": "github"
    },
    "installCommand": "string",
    "name": "a-project-name",
    "skipGitConnectDuringLink": "true",
    "ssoProtection": {
      "deploymentType": "all"
    },
    "sandbox": {
      "region": "iad1",
      "failoverRegions": []
    },
    "outputDirectory": "string",
    "publicSource": "true",
    "rootDirectory": "string",
    "serverlessFunctionRegion": "string",
    "serverlessFunctionZeroConfigFailover": "true",
    "oidcTokenConfig": {
      "enabled": "true",
      "issuerMode": "team"
    },
    "enableAffectedProjectsDeployments": "true",
    "resourceConfig": {
      "buildMachineType": "basic",
      "fluid": "true",
      "functionDefaultRegions": [],
      "functionDefaultTimeout": "123",
      "functionDefaultMemoryType": "standard_legacy",
      "functionZeroConfigFailover": "true",
      "elasticConcurrencyEnabled": "true",
      "buildMachineSelection": "elastic",
      "buildMachineElasticLastUpdated": "123",
      "buildMachineElasticReason": "oom-failure",
      "isNSNBDisabled": "true",
      "buildQueue": {
        "configuration": "SKIP_NAMESPACE_QUEUE"
      },
      "enableFunctionsBeta": "true"
    }
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "accountId": "example_id",
  "creator": {
    "type": "user",
    "via": {
      "type": "app",
      "app": {
        "id": "icfg_1234567890",
        "clientId": "example_id"
      }
    },
    "user": {
      "id": "icfg_1234567890"
    }
  },
  "alias": [
    {
      "configuredBy": "A",
      "configuredChangedAt": "123",
      "createdAt": "123",
      "deployment": {
        "id": "icfg_1234567890",
        "alias": [],
        "aliasAssigned": "123",
        "aliasError": {
          "code": "string",
          "message": "string"
        },
        "aliasFinal": "string",
        "automaticAliases": [],
        "branchMatcher": {
          "type": "endsWith",
          "pattern": "string"
        },
        "buildingAt": "123",
        "builds": [
          {
            "use": "string",
            "src": "string",
            "dest": "string"
          }
        ],
        "checksConclusion": "canceled",
        "checksState": "completed",
        "connectBuildsEnabled": "false",
        "connectConfigurationId": "example_id",
        "createdAt": "123",
        "createdIn": "string",
        "creator": {
          "email": "user@example.com",
          "githubLogin": "string",
          "gitlabLogin": "string",
          "uid": "example_id",
          "username": "string"
        },
        "deletedAt": "123",
        "deploymentHostname": "Example Name",
        "forced": "false",
        "name": "Example Name",
        "meta": "value",
        "monorepoManager": "string",
        "oidcTokenClaims": {
          "iss": "string",
          "sub": "string",
          "scope": "string",
          "aud": "string",
          "owner": "string",
          "owner_id": "example_id",
          "project": "string",
          "project_id": "example_id",
          "environment": "string",
          "custom_environment_id": "example_id",
          "mfe_group_ids": [],
          "plan": "string"
        },
        "plan": "enterprise",
        "previewCommentsEnabled": "false",
        "private": "false",
        "readyAt": "123",
        "readyState": "BLOCKED",
        "readySubstate": "PROMOTED",
        "requestedAt": "123",
        "target": "string",
        "teamId": "example_id",
        "type": "LAMBDAS",
        "url": "https://example.com",
        "userId": "example_id",
        "withCache": "false"
      },
      "domain": "string",
      "environment": "preview",
      "gitBranch": "string",
      "redirect": "string",
      "redirectStatusCode": "301",
      "target": "PREVIEW"
    }
  ],
  "analytics": {
    "id": "icfg_1234567890",
    "canceledAt": "123",
    "disabledAt": "123",
    "enabledAt": "123",
    "paidAt": "123",
    "sampleRatePercent": "123",
    "spendLimitInDollars": "123"
  },
  "appliedCve55182Migration": "false",
  "speedInsights": {
    "id": "icfg_1234567890",
    "enabledAt": "123",
    "disabledAt": "123",
    "canceledAt": "123",
    "hasData": "false",
    "dataReceivedAt": "123",
    "paidAt": "123"
  },
  "autoExposeSystemEnvs": "false",
  "autoAssignCustomDomains": "false",
  "autoAssignCustomDomainsUpdatedBy": "string",
  "buildCommand": "string",
  "commandForIgnoringBuildStep": "string",
  "connectConfigurations": [
    {
      "envId": "example_id",
      "connectConfigurationId": "example_id",
      "dc": "string",
      "passive": "false",
      "buildsEnabled": "false",
      "aws": {
        "subnetIds": [],
        "securityGroupId": "https://example.com"
      },
      "createdAt": "123",
      "updatedAt": "123"
    }
  ],
  "connectConfigurationId": "example_id",
  "connectBuildsEnabled": "false",
  "passiveConnectConfigurationId": "example_id",
  "createdAt": "123",
  "customerSupportCodeVisibility": "false",
  "crons": {
    "enabledAt": "123",
    "disabledAt": "123",
    "updatedAt": "123",
    "deploymentId": "example_id",
    "definitions": [
      {
        "host": "vercel.com",
        "path": "/api/crons/sync-something?hello=world",
        "schedule": "0 0 * * *",
        "source": "api",
        "description": "string",
        "hostInferred": "false"
      }
    ]
  },
  "dataCache": {
    "userDisabled": "false",
    "storageSizeBytes": "123",
    "unlimited": "false"
  },
  "deploymentExpiration": {
    "expirationDays": "123",
    "expirationDaysProduction": "123",
    "expirationDaysCanceled": "123",
    "expirationDaysErrored": "123",
    "deploymentsToKeep": "123"
  },
  "expiration": {
    "expiresAt": "123"
  },
  "devCommand": "string",
  "directoryListing": "false",
  "installCommand": "string",
  "env": [
    {
      "target": [],
      "type": "encrypted",
      "sunsetSecretId": "example_id",
      "legacyValue": "string",
      "decrypted": "false",
      "value": "string",
      "vsmValue": "string",
      "id": "icfg_1234567890",
      "key": "string",
      "configurationId": "example_id",
      "createdAt": "123",
      "updatedAt": "123",
      "createdBy": "string",
      "updatedBy": "string",
      "gitBranch": "string",
      "visibility": "config",
      "edgeConfigId": "example_id",
      "edgeConfigTokenId": "example_id",
      "contentHint": {
        "type": "redis-url",
        "storeId": "example_id"
      },
      "internalContentHint": {
        "type": "flags-secret",
        "encryptedValue": "string"
      },
      "comment": "string",
      "customEnvironmentIds": []
    }
  ],
  "customEnvironments": [
    {
      "id": "icfg_1234567890",
      "slug": "string",
      "type": "development",
      "description": "string",
      "branchMatcher": {
        "type": "endsWith",
        "pattern": "string"
      },
      "domains": [
        {
          "name": "Example Name",
          "apexName": "Example Name",
          "projectId": "example_id",
          "redirect": "string",
          "redirectStatusCode": "301",
          "gitBranch": "string",
          "customEnvironmentId": "example_id",
          "updatedAt": "123",
          "createdAt": "123",
          "verified": "false",
          "verification": [
            {
              "type": "string",
              "domain": "string",
              "value": "string",
              "reason": "Customer requested refund"
            }
          ]
        }
      ],
      "currentDeploymentAliases": [],
      "createdAt": "123",
      "updatedAt": "123"
    }
  ],
  "framework": "actix-web",
  "services": [
    {
      "serviceName": "Example Name",
      "serviceType": "cron",
      "framework": "actix-web",
      "runtime": "string"
    }
  ],
  "gitForkProtection": "false",
  "gitLFS": "false",
  "id": "icfg_1234567890",
  "ipBuckets": [
    {
      "bucket": "string",
      "default": "false",
      "supportUntil": "123"
    }
  ],
  "jobs": {
    "lint": {
      "targets": []
    },
    "typecheck": {
      "targets": []
    },
    "mfe-config-present": {
      "targets": []
    }
  },
  "latestDeployments": [
    {
      "id": "icfg_1234567890",
      "alias": [],
      "aliasAssigned": "123",
      "aliasError": {
        "code": "string",
        "message": "string"
      },
      "aliasFinal": "string",
      "automaticAliases": [],
      "branchMatcher": {
        "type": "endsWith",
        "pattern": "string"
      },
      "buildingAt": "123",
      "builds": [
        {
          "use": "string",
          "src": "string",
          "dest": "string"
        }
      ],
      "checksConclusion": "canceled",
      "checksState": "completed",
      "connectBuildsEnabled": "false",
      "connectConfigurationId": "example_id",
      "createdAt": "123",
      "createdIn": "string",
      "creator": {
        "email": "user@example.com",
        "githubLogin": "string",
        "gitlabLogin": "string",
        "uid": "example_id",
        "username": "string"
      },
      "deletedAt": "123",
      "deploymentHostname": "Example Name",
      "forced": "false",
      "name": "Example Name",
      "meta": "value",
      "monorepoManager": "string",
      "oidcTokenClaims": {
        "iss": "string",
        "sub": "string",
        "scope": "string",
        "aud": "string",
        "owner": "string",
        "owner_id": "example_id",
        "project": "string",
        "project_id": "example_id",
        "environment": "string",
        "custom_environment_id": "example_id",
        "mfe_group_ids": [],
        "plan": "string"
      },
      "plan": "enterprise",
      "previewCommentsEnabled": "false",
      "private": "false",
      "readyAt": "123",
      "readyState": "BLOCKED",
      "readySubstate": "PROMOTED",
      "requestedAt": "123",
      "target": "string",
      "teamId": "example_id",
      "type": "LAMBDAS",
      "url": "https://example.com",
      "userId": "example_id",
      "withCache": "false"
    }
  ],
  "link": {
    "org": "string",
    "repoOwnerId": "123",
    "repo": "string",
    "repoId": "123",
    "type": "github",
    "createdAt": "123",
    "deployHooks": [
      {
        "createdAt": "123",
        "id": "icfg_1234567890",
        "name": "Example Name",
        "ref": "string",
        "url": "https://example.com"
      }
    ],
    "gitCredentialId": "example_id",
    "updatedAt": "123",
    "sourceless": "false",
    "productionBranch": "string"
  },
  "blobs": {
    "isDefaultApp": "false"
  },
  "microfrontends": {
    "isDefaultApp": "true",
    "updatedAt": "123",
    "groupIds": [],
    "enabled": "true",
    "defaultRoute": "string",
    "freeProjectForLegacyLimits": "false"
  },
  "name": "Example Name",
  "nodeVersion": "10.x",
  "optionsAllowlist": {
    "paths": [
      {
        "value": "string"
      }
    ]
  },
  "outputDirectory": "string",
  "passwordProtection": "value",
  "passport": {
    "deploymentType": "all",
    "connectorId": "example_id"
  },
  "protectionConfig": {
    "sandboxUrls": {
      "inheritDeploymentProtection": "false"
    }
  },
  "sandbox": {
    "region": "arn1",
    "failoverRegions": []
  },
  "productionDeploymentsFastLane": "false",
  "resourceConfig": {
    "elasticConcurrencyEnabled": "false",
    "fluid": "false",
    "functionDefaultRegions": [],
    "functionDefaultTimeout": "123",
    "functionDefaultMemoryType": "performance",
    "functionZeroConfigFailover": "false",
    "buildMachineType": "basic",
    "buildMachineSelection": "elastic",
    "buildMachineElasticLastUpdated": "123",
    "buildMachineElasticReason": "basic-floor",
    "isNSNBDisabled": "false",
    "buildQueue": {
      "configuration": "SKIP_NAMESPACE_QUEUE"
    },
    "enableFunctionsBeta": "false"
  },
  "rollbackDescription": {
    "userId": "example_id",
    "username": "string",
    "description": "string",
    "createdAt": "123"
  },
  "rollingRelease": {
    "target": "production",
    "stages": [
      {
        "targetPercentage": "25",
        "requireApproval": "false",
        "duration": "600",
        "linearShift": "false"
      }
    ],
    "canaryResponseHeader": "false",
    "gate": {
      "enabled": "false",
      "checks": [
        {
          "type": "error-rate-5xx",
          "minSampleSize": "100",
          "excludeStatusCodes": [],
          "excludePaths": [],
          "ingestWatermarkSeconds": "30"
        }
      ],
      "failureThreshold": "3",
      "windowSize": "5",
      "action": "pause",
      "dryRun": "false"
    }
  },
  "defaultResourceConfig": {
    "elasticConcurrencyEnabled": "false",
    "fluid": "false",
    "functionDefaultRegions": [],
    "functionDefaultTimeout": "123",
    "functionDefaultMemoryType": "performance",
    "functionZeroConfigFailover": "false",
    "buildMachineType": "basic",
    "buildMachineSelection": "elastic",
    "buildMachineElasticLastUpdated": "123",
    "buildMachineElasticReason": "basic-floor",
    "isNSNBDisabled": "false",
    "buildQueue": {
      "configuration": "SKIP_NAMESPACE_QUEUE"
    },
    "enableFunctionsBeta": "false"
  },
  "rootDirectory": "string",
  "serverlessFunctionZeroConfigFailover": "false",
  "skewProtectionBoundaryAt": "123",
  "skewProtectionMaxAge": "123",
  "skewProtectionAllowedDomains": [],
  "skipGitConnectDuringLink": "false",
  "staticIps": {
    "builds": "false",
    "enabled": "false",
    "regions": []
  },
  "sourceFilesOutsideRootDirectory": "false",
  "enableAffectedProjectsDeployments": "false",
  "enableExternalRewriteCaching": "false",
  "ssoProtection": {
    "deploymentType": "all",
    "cve55182MigrationAppliedFrom": "all",
    "april2026SecurityIncidentMigrationAppliedFrom": "all"
  },
  "targets": "value",
  "transferCompletedAt": "123",
  "transferStartedAt": "123",
  "transferToAccountId": "example_id",
  "transferredFromAccountId": "example_id",
  "updatedAt": "123",
  "live": "false",
  "enablePreviewFeedback": "false",
  "enableProductionFeedback": "false",
  "permissions": {
    "oauth2Connection": [],
    "user": [],
    "userConnection": [],
    "userMfaConfiguration": [],
    "userPreference": [],
    "userSudo": [],
    "webAuthn": [],
    "accessGroup": [],
    "agent": [],
    "aiGatewayApiKey": [],
    "aiGatewayApiKeyBypassAll": [],
    "aiGatewayApiKeyOwnedBySelf": [],
    "aiGatewayApiKeySpendAttribution": [],
    "aiGatewayApiKeyZdrExemption": [],
    "aiGatewayBudget": [],
    "aiGatewayCredits": [],
    "aiGatewayPrivateModels": [],
    "aiGatewayGuardrails": [],
    "aiGatewayRules": [],
    "aiGatewaySettings": [],
    "aiGatewayTranscripts": [],
    "aiGatewayTranscriptsSettings": [],
    "aiGatewayUsage": [],
    "aiGatewayVirtualModelConfigs": [],
    "alerts": [],
    "alertRules": [],
    "aliasGlobal": [],
    "analyticsSampling": [],
    "analyticsUsage": [],
    "apiKey": [],
    "apiKeyAiGateway": [],
    "apiKeyOwnedBySelf": [],
    "oauth2Application": [],
    "vercelAppInstallation": [],
    "vercelAppInstallationRequest": [],
    "auditLog": [],
    "automation": [],
    "billingAddress": [],
    "billingInformation": [],
    "billingInvoice": [],
    "billingInvoiceEmailRecipient": [],
    "billingInvoiceLanguage": [],
    "billingPlan": [],
    "billingPurchaseOrder": [],
    "billingRefund": [],
    "billingTaxId": [],
    "blob": [],
    "blobStoreTokenSet": [],
    "budget": [],
    "cacheArtifact": [],
    "cacheArtifactUsageEvent": [],
    "codeChecks": [],
    "codeOwners": [],
    "ciInvocations": [],
    "ciLogs": [],
    "concurrentBuilds": [],
    "connect": [],
    "connectConfiguration": [],
    "connectLogs": [],
    "connexClient": [],
    "connexClientProject": [],
    "connexContact": [],
    "connexInstallation": [],
    "connexToken": [],
    "buildMachineDefault": [],
    "cursorOriginInstallation": [],
    "dataCacheBillingSettings": [],
    "defaultDeploymentProtection": [],
    "deploymentPolicy": [],
    "domain": [],
    "domainAcceptDelegation": [],
    "domainAuthCodes": [],
    "domainCertificate": [],
    "domainCheckConfig": [],
    "domainMove": [],
    "domainPurchase": [],
    "domainRecord": [],
    "domainTransferIn": [],
    "drain": [],
    "edgeConfig": [],
    "edgeConfigItem": [],
    "edgeConfigSchema": [],
    "edgeConfigToken": [],
    "endpointVerification": [],
    "event": [],
    "fileUpload": [],
    "flagsExplorerSubscription": [],
    "gitRepository": [],
    "imageOptimizationNewPrice": [],
    "integration": [],
    "integrationAccount": [],
    "integrationConfiguration": [],
    "integrationConfigurationProjects": [],
    "integrationConfigurationRole": [],
    "integrationConfigurationTransfer": [],
    "integrationDeploymentAction": [],
    "integrationEvent": [],
    "integrationLog": [],
    "integrationResource": [],
    "integrationResourceData": [],
    "integrationResourceReplCommand": [],
    "integrationResourceSecrets": [],
    "integrationSSOSession": [],
    "integrationStrict": [],
    "integrationStoreTokenSet": [],
    "integrationVercelConfigurationOverride": [],
    "integrationPullRequest": [],
    "ipBlocking": [],
    "jobGlobal": [],
    "kmsIssuer": [],
    "kmsProjectGrant": [],
    "logDrain": [],
    "marketplaceBillingData": [],
    "marketplaceExperimentationEdgeConfigData": [],
    "marketplaceExperimentationItem": [],
    "marketplaceFlexCommit": [],
    "marketplaceInstallationMember": [],
    "marketplaceInvoice": [],
    "marketplaceSettings": [],
    "Monitoring": [],
    "monitoringAlert": [],
    "monitoringChart": [],
    "monitoringQuery": [],
    "monitoringSettings": [],
    "notificationCustomerBudget": [],
    "notificationDeploymentFailed": [],
    "notificationDomainConfiguration": [],
    "notificationDomainExpire": [],
    "notificationDomainMoved": [],
    "notificationDomainPurchase": [],
    "notificationDomainRenewal": [],
    "notificationDomainTransfer": [],
    "notificationDomainUnverified": [],
    "NotificationMonitoringAlert": [],
    "notificationPaymentFailed": [],
    "notificationPreferences": [],
    "notificationStatementOfReasons": [],
    "notificationUsageAlert": [],
    "oidcFederationPolicy": [],
    "observabilityConfiguration": [],
    "observabilityFunnel": [],
    "observabilityNotebook": [],
    "openTelemetryEndpoint": [],
    "ownEvent": [],
    "organization": [],
    "organizationDomain": [],
    "organizationTeam": [],
    "passwordProtectionInvoiceItem": [],
    "paymentMethod": [],
    "permissions": [],
    "postgres": [],
    "postgresStoreTokenSet": [],
    "previewDeploymentSuffix": [],
    "privateCloudAccount": [],
    "projectTransferIn": [],
    "projectTransferRequest": [],
    "proTrialOnboarding": [],
    "rateLimit": [],
    "redis": [],
    "redisStoreTokenSet": [],
    "remoteCaching": [],
    "repository": [],
    "samlConfig": [],
    "secret": [],
    "securityConfig": [],
    "sensitiveEnvironmentVariablePolicy": [],
    "sharedEnvVars": [],
    "sharedEnvVarsProduction": [],
    "space": [],
    "spaceRun": [],
    "storeIsLocked": [],
    "storeTokenSetSensitive": [],
    "storeTransfer": [],
    "supportCase": [],
    "supportCaseComment": [],
    "team": [],
    "teamAccessRequest": [],
    "teamFellowMembership": [],
    "teamGitExclusivity": [],
    "teamInvite": [],
    "teamInviteCode": [],
    "teamInviteLink": [],
    "teamJoin": [],
    "teamMemberMfaStatus": [],
    "teamMicrofrontends": [],
    "teamOwnMembership": [],
    "teamOwnMembershipDisconnectSAML": [],
    "teamSudo": [],
    "teamTokenInvalidation": [],
    "token": [],
    "toolbarComment": [],
    "usage": [],
    "usageCycle": [],
    "vcrRepository": [],
    "vpcPeeringConnection": [],
    "webAnalyticsPlan": [],
    "webhook": [],
    "webhook-event": [],
    "aliasProject": [],
    "aliasProtectionBypass": [],
    "bulkRedirects": [],
    "buildMachine": [],
    "connectConfigurationLink": [],
    "dataCacheNamespace": [],
    "deployment": [],
    "deploymentBuildLogs": [],
    "deploymentCheck": [],
    "deploymentCheckPreview": [],
    "deploymentCheckReRunFromProductionBranch": [],
    "deploymentProductionGit": [],
    "deploymentV0": [],
    "deploymentPreview": [],
    "deploymentPrivate": [],
    "deploymentPromote": [],
    "deploymentRollback": [],
    "edgeCacheNamespace": [],
    "environments": [],
    "job": [],
    "logs": [],
    "logsPreset": [],
    "observabilityData": [],
    "onDemandBuild": [],
    "onDemandConcurrency": [],
    "optionsAllowlist": [],
    "passwordProtection": [],
    "privateLinkEndpoint": [],
    "productionAliasProtectionBypass": [],
    "productionShareableLink": [],
    "project": [],
    "projectAccessGroup": [],
    "projectAnalyticsSampling": [],
    "projectAnalyticsUsage": [],
    "projectCheck": [],
    "projectCheckRun": [],
    "projectDeploymentExpiration": [],
    "projectDeploymentHook": [],
    "projectDeploymentProtectionStrict": [],
    "projectDomain": [],
    "projectDomainCheckConfig": [],
    "projectDomainMove": [],
    "projectDomainVerify": [],
    "projectEvent": [],
    "projectEnvVars": [],
    "projectEnvVarsProduction": [],
    "projectEnvVarsUnownedByIntegration": [],
    "projectFlags": [],
    "projectFlagsProduction": [],
    "projectFlagsSdkKey": [],
    "projectFromV0": [],
    "projectId": [],
    "projectIntegrationConfiguration": [],
    "projectLink": [],
    "projectMember": [],
    "projectMonitoring": [],
    "projectOIDCToken": [],
    "projectPermissions": [],
    "projectProductionBranch": [],
    "projectProtectionBypass": [],
    "projectRollingRelease": [],
    "projectRoutes": [],
    "projectSupportCase": [],
    "projectSupportCaseComment": [],
    "projectTier": [],
    "projectTransfer": [],
    "projectTransferOut": [],
    "projectUsage": [],
    "pageIntegrity": [],
    "seawallConfig": [],
    "securityPlusConfiguration": [],
    "shareableLink": [],
    "shareableLinkStrict": [],
    "sharedEnvVarConnection": [],
    "skewProtection": [],
    "analytics": [],
    "trustedIps": [],
    "trustedSources": [],
    "v0Chat": [],
    "vercelAuth": [],
    "vercelRun": [],
    "webAnalytics": [],
    "workflowRunData": []
  },
  "lastRollbackTarget": "value",
  "lastAliasRequest": {
    "fromDeploymentId": "example_id",
    "toDeploymentId": "example_id",
    "fromRollingReleaseId": "example_id",
    "jobStatus": "failed",
    "requestedAt": "123",
    "type": "promote"
  },
  "protectionBypass": "value",
  "hasActiveBranches": "false",
  "trustedIps": {
    "deploymentType": "all",
    "addresses": [
      {
        "value": "string",
        "note": "string"
      }
    ],
    "protectionMode": "additional"
  },
  "trustedSources": {
    "enableVercelCiSameRepository": "false",
    "projects": "value",
    "oidcProviders": "value"
  },
  "gitComments": {
    "onPullRequest": "false",
    "onCommit": "false"
  },
  "gitProviderOptions": {
    "createDeployments": "disabled",
    "disableRepositoryDispatchEvents": "false",
    "requireVerifiedCommits": "false",
    "gitCommitStatus": "false",
    "consolidatedGitCommitStatus": {
      "enabled": "false",
      "propagateFailures": "false"
    }
  },
  "paused": "false",
  "concurrencyBucketName": "Example Name",
  "webAnalytics": {
    "id": "icfg_1234567890",
    "disabledAt": "123",
    "canceledAt": "123",
    "enabledAt": "123",
    "hasData": "true"
  },
  "security": {
    "attackModeEnabled": "false",
    "attackModeUpdatedAt": "123",
    "firewallEnabled": "false",
    "firewallUpdatedAt": "123",
    "attackModeActiveUntil": "123",
    "firewallConfigVersion": "123",
    "rulesets": "value",
    "firewallSeawallEnabled": "false",
    "ja3Enabled": "false",
    "ja4Enabled": "false",
    "firewallBypassIps": [],
    "managedRules": {
      "vercel_ruleset": {
        "active": "false",
        "action": "challenge"
      },
      "traffic_sources": {
        "active": "false",
        "action": "challenge"
      },
      "bot_filter": {
        "active": "false",
        "action": "challenge"
      },
      "ai_bots": {
        "active": "false",
        "action": "challenge"
      },
      "owasp": {
        "active": "false",
        "action": "challenge"
      }
    },
    "botIdEnabled": "false",
    "log_headers": [],
    "securityPlus": "false",
    "securityPlusMetadata": {
      "updatedAt": "123",
      "firstEnabledAt": "123"
    },
    "pageIntegrityEnabled": "false"
  },
  "oidcTokenConfig": {
    "enabled": "false",
    "issuerMode": "global"
  },
  "deploymentPolicy": {
    "gitSources": [
      {
        "sources": [
          {
            "provider": "bitbucket",
            "org": "string",
            "repo": "string"
          }
        ],
        "enabled": "false",
        "environments": [
          {
            "type": "system",
            "target": "preview"
          }
        ]
      }
    ],
    "deploymentSources": [
      {
        "sources": [],
        "enabled": "false",
        "environments": [
          {
            "type": "system",
            "target": "preview"
          }
        ]
      }
    ]
  },
  "tier": "advanced",
  "usageStatus": {
    "kind": "flat",
    "exceededAllowanceUntil": "123",
    "bypassThrottleUntil": "123",
    "throttled": "false",
    "teamThrottled": "false"
  },
  "features": {
    "webAnalytics": "false"
  },
  "v0": "false",
  "v0Created": "false",
  "abuse": {
    "scanner": "string",
    "history": [
      {
        "scanner": "string",
        "reason": "Customer requested refund",
        "by": "string",
        "byId": "example_id",
        "at": "123"
      }
    ],
    "updatedAt": "123",
    "block": {
      "action": "blocked",
      "reason": "Customer requested refund",
      "statusCode": "123",
      "createdAt": "123",
      "caseId": "example_id",
      "actor": "string",
      "comment": "string",
      "ineligibleForAppeal": "false",
      "isCascading": "false"
    },
    "blockHistory": [
      {
        "action": "blocked",
        "reason": "Customer requested refund",
        "statusCode": "123",
        "createdAt": "123",
        "caseId": "example_id",
        "actor": "string",
        "comment": "string",
        "ineligibleForAppeal": "false",
        "isCascading": "false"
      }
    ],
    "interstitial": "false",
    "interstitialHistory": [
      {
        "action": "add-deployment-interstitial",
        "createdAt": "123",
        "caseId": "example_id",
        "reason": "Customer requested refund",
        "actor": "string",
        "comment": "string"
      }
    ]
  },
  "internalRoutes": [
    {
      "src": "string",
      "status": "123",
      "expiry": "123"
    }
  ],
  "hasDeployments": "false",
  "dismissedToasts": [
    {
      "key": "string",
      "dismissedAt": "123",
      "action": "accept",
      "value": "string"
    }
  ],
  "protectedSourcemaps": "false",
  "tracing": {
    "domains": "string",
    "ignorePaths": [],
    "samplingRules": [
      {
        "rate": "123",
        "env": "preview",
        "requestPath": "string",
        "destination": "external"
      }
    ]
  },
  "avatar": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

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
enablePreviewFeedbackbooleanOptional
Opt-in to preview toolbar on the project level
enableProductionFeedbackbooleanOptional
Opt-in to production toolbar on the project level
previewDeploymentsDisabledbooleanOptional
Specifies whether preview deployments are disabled for this project.
previewDeploymentSuffixstringOptional
Custom domain suffix for preview deployments. Takes precedence over team-level suffix. Must be a domain owned by the team.
buildCommandstringOptional
The build command for this project. When null is used this value will be automatically detected
commandForIgnoringBuildStepstringOptional
devCommandstringOptional
The dev command for this project. When null is used this value will be automatically detected
environmentVariablesarrayOptional
Collection of ENV Variables the Project will use
frameworkobjectOptional
The framework that is being used for this project. When null is used no framework is selected
gitRepositoryobjectOptional
The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed
installCommandstringOptional
The install command for this project. When null is used this value will be automatically detected
namestringRequired
The desired name for the project
ssoProtectionobjectOptional
The Vercel Auth setting for the project (historically named "SSO Protection")
sandboxobjectOptional
Specifies the default region and failover regions for sandboxes created in the project
outputDirectorystringOptional
The output directory of the project. When null is used this value will be automatically detected
publicSourcebooleanOptionalDeprecated
Deprecated. Accepted for backwards compatibility but ignored.
rootDirectorystringOptional
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
serverlessFunctionRegionstringOptional
The region to deploy Serverless Functions in this project
serverlessFunctionZeroConfigFailoverbooleanOptional
oidcTokenConfigobjectOptional
OpenID Connect JSON Web Token generation configuration.
enableAffectedProjectsDeploymentsbooleanOptional
Opt-in to skip deployments when there are no changes to the root directory and its dependencies
resourceConfigobjectOptional
Specifies resource override configuration for the project

Response

200The project was successfuly created
accountIdstringRequired
creatorobjectOptional4 variants
aliasarrayRequired
analyticsobjectOptional
appliedCve55182MigrationbooleanOptional
speedInsightsobjectOptional
autoExposeSystemEnvsbooleanOptional
autoAssignCustomDomainsbooleanOptional
autoAssignCustomDomainsUpdatedBystringOptional
buildCommandstringOptional
commandForIgnoringBuildStepstringOptional
connectConfigurationsarrayOptional
connectConfigurationIdstringOptional
connectBuildsEnabledbooleanOptional
passiveConnectConfigurationIdstringOptional
createdAtnumberOptional
customerSupportCodeVisibilitybooleanOptional
cronsobjectOptional
dataCacheobjectOptional
deploymentExpirationobjectRequired
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.
expirationobjectOptional2 variants
devCommandstringOptional
directoryListingbooleanRequired
installCommandstringOptional
envarrayOptional
customEnvironmentsarrayOptional
frameworkstringOptional
servicesarrayOptional
gitForkProtectionbooleanOptional
gitLFSbooleanOptional
idstringRequired
ipBucketsarrayOptional
jobsobjectOptional
latestDeploymentsarrayOptional
blobsobjectOptional
microfrontendsobjectOptional3 variants
namestringRequired
nodeVersionstringRequired
optionsAllowlistobjectOptional
outputDirectorystringOptional
passwordProtectionobjectOptional
passportobjectOptional
protectionConfigobjectOptional
sandboxobjectOptional
productionDeploymentsFastLanebooleanOptional
resourceConfigobjectRequired
rollbackDescriptionobjectOptional
Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback.
rollingReleaseobjectOptional
Project-level rolling release configuration that defines how deployments should be gradually rolled out
defaultResourceConfigobjectRequired
rootDirectorystringOptional
serverlessFunctionZeroConfigFailoverbooleanOptional
skewProtectionBoundaryAtnumberOptional
skewProtectionMaxAgenumberOptional
skewProtectionAllowedDomainsarrayOptional
staticIpsobjectOptional
sourceFilesOutsideRootDirectorybooleanOptional
enableAffectedProjectsDeploymentsbooleanOptional
enableExternalRewriteCachingbooleanOptional
ssoProtectionobjectOptional
targetsobjectOptional
transferCompletedAtnumberOptional
transferStartedAtnumberOptional
transferToAccountIdstringOptional
transferredFromAccountIdstringOptional
updatedAtnumberOptional
livebooleanOptional
enablePreviewFeedbackbooleanOptional
enableProductionFeedbackbooleanOptional
permissionsobjectOptional
lastRollbackTargetobjectOptional
lastAliasRequestobjectOptional
protectionBypassobjectOptional
hasActiveBranchesbooleanOptional
trustedIpsobjectOptional2 variants
trustedSourcesobjectOptional
gitCommentsobjectOptional
gitProviderOptionsobjectOptional
pausedbooleanOptional
concurrencyBucketNamestringOptional
webAnalyticsobjectOptional
securityobjectOptional
oidcTokenConfigobjectOptional
deploymentPolicyobjectOptional
Project shape. null on a rule list clears the project's override for that rule type (fall back to team for every env); omitting is equivalent. Setting deploymentPolicy itself to null clears every override at once. Kept structurally distinct from {@link TeamDeploymentPolicy} so the two storage locations don't share a type by accident.
tierstringOptional
usageStatusobjectOptional
featuresobjectOptional
v0booleanOptional
v0CreatedbooleanOptional
abuseobjectOptional
internalRoutesarrayOptional
hasDeploymentsbooleanOptional
dismissedToastsarrayOptional
protectedSourcemapsbooleanOptional
tracingobjectOptional
avatarstringOptional

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. At least one environment variable failed validation The Bitbucket Webhook for the project link could not be created The Gitlab Webhook for the project link could not be created
401The request is not authorized.
402The account is missing a payment so payment method must be updated Pro customers are allowed to deploy Serverless Functions to up to `proMaxRegions` regions, or if the project was created before the limit was introduced. Deploying to Serverless Functions to multiple regions requires a plan update
403You do not have permission to access this resource.
404Error
409A project with the provided name already exists.
410Error
428Error
429Error
500Error