PATCH /v1/projects/{projectId}/microfrontends
Update the microfrontends settings for a project.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
String | Yes |
The unique project identifier |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
slug |
String | No |
The Team slug to perform the request on behalf of. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
isDefaultApp |
Boolean | No |
Whether the application is the default application for the microfrontends group |
routeObservabilityToThisProject |
Boolean | No |
Whether observability data should be routed to this project or a root project. Can only be set for child applications. |
enabled |
Boolean | No |
Enable or disable microfrontends for the project |
defaultRoute |
String | No |
The default route used for screenshots and preview links for the project |
doNotRouteWithMicrofrontendsRouting |
Boolean | No |
Whether domains in this project should route as a microfrontend. Can only be set for child applications. |
microfrontendsGroupId |
String | No |
The unique group identifier to add this microfrontend to |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.