Sign in

v18

latestOpenAPI 3.0.32026-08-07378889.6 MB
projects

Update the microfrontends settings

Update the microfrontends settings for a project.

patch/v1/projects/{projectId}/microfrontends

Path parameters

projectIdstring required

The unique project identifier

Example:prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB

The unique project identifier

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

microfrontendsGroupIdstring

The unique group identifier to add this microfrontend to

enabledboolean

Enable or disable microfrontends for the project

isDefaultAppboolean

Whether the application is the default application for the microfrontends group

defaultRoutestring

The default route used for screenshots and preview links for the project

routeObservabilityToThisProjectboolean

Whether observability data should be routed to this project or a root project. Can only be set for child applications.

doNotRouteWithMicrofrontendsRoutingboolean

Whether domains in this project should route as a microfrontend. Can only be set for child applications.

Example request

{
  "microfrontendsGroupId": "mfe_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
  "enabled": true,
  "isDefaultApp": true,
  "defaultRoute": "/home"
}

Response

accountIdstring required
appliedCve55182Migrationfalse | true
autoExposeSystemEnvsfalse | true
autoAssignCustomDomainsfalse | true
autoAssignCustomDomainsUpdatedBystring
buildCommandstring nullable
commandForIgnoringBuildStepstring nullable
connectConfigurationIdstring nullable
connectBuildsEnabledfalse | true
passiveConnectConfigurationIdstring nullable
createdAtnumber
customerSupportCodeVisibilityfalse | true
devCommandstring nullable
directoryListingfalse | true required
installCommandstring nullable
framework'actix-web' | 'angular' | 'ash' | 'astro' | 'axum' | 'blitzjs' | 'brunch' | 'bun' | 'container' | 'create-react-app' | 'django' | 'docusaurus' | 'docusaurus-2' | 'dojo' | 'eleventy' | 'elysia' | 'ember' | 'eve' | 'express' | 'fastapi' | 'fasthtml' | 'fastify' | 'flask' | 'gatsby' | 'go' | 'gridsome' | 'h3' | 'hexo' | 'hono' | 'hugo' | 'hydrogen' | 'ionic-angular' | 'ionic-react' | 'jekyll' | 'koa' | 'mastra' | 'middleman' | 'nestjs' | 'nextjs' | 'nitro' | 'node' | 'nuxtjs' | 'parcel' | 'polymer' | 'preact' | 'python' | 'react-router' | 'redwoodjs' | 'remix' | 'ruby' | 'rust' | 'saber' | 'sanity' | 'sanity-v2' | 'sapper' | 'scully' | 'services' | 'solidstart' | 'solidstart-1' | 'stencil' | 'storybook' | 'svelte' | 'sveltekit' | 'sveltekit-1' | 'tanstack-start' | 'tanstack-start-lovable' | 'umijs' | 'vite' | 'vitepress' | 'vue' | 'vuepress' | 'xmcp' | 'zola' | 'null' nullable
gitForkProtectionfalse | true
gitLFSfalse | true
idstring required
namestring required
nodeVersion'10.x' | '12.x' | '14.x' | '16.x' | '18.x' | '20.x' | '22.x' | '24.x' | '8.10.x' required
outputDirectorystring nullable
passwordProtectionobject nullable
productionDeploymentsFastLanefalse | true
rootDirectorystring nullable
serverlessFunctionZeroConfigFailoverfalse | true
skewProtectionBoundaryAtnumber
skewProtectionMaxAgenumber
skewProtectionAllowedDomainsstring[]
skipGitConnectDuringLinkfalse | true
sourceFilesOutsideRootDirectoryfalse | true
enableAffectedProjectsDeploymentsfalse | true
enableExternalRewriteCachingfalse | true
targetsobject
transferCompletedAtnumber
transferStartedAtnumber
transferToAccountIdstring
transferredFromAccountIdstring
updatedAtnumber
livefalse | true
enablePreviewFeedbackfalse | true | null nullable
enableProductionFeedbackfalse | true | null nullable
lastRollbackTargetobject nullable
protectionBypassobject
hasActiveBranchesfalse | true
pausedfalse | true
concurrencyBucketNamestring
tierstring
v0false | true
v0Createdfalse | true
hasDeploymentsfalse | true
protectedSourcemapsfalse | true
avatarstring nullable

Example response

{
  "crons": {
    "definitions": [
      {
        "host": "vercel.com",
        "path": "/api/crons/sync-something?hello=world",
        "schedule": "0 0 * * *"
      }
    ]
  },
  "rollingRelease": {
    "target": "production",
    "stages": [
      {
        "targetPercentage": 25,
        "duration": 600
      }
    ],
    "gate": {
      "checks": [
        {
          "minSampleSize": 100,
          "excludeStatusCodes": [
            503
          ],
          "excludePaths": [
            "/api/health"
          ],
          "ingestWatermarkSeconds": 30
        }
      ],
      "failureThreshold": 3,
      "windowSize": 5
    }
  }
}