POST /v1/microfrontends/group
Creates a microfrontends group and attaches multiple projects in a single request.
Servers
- https://api.vercel.com
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 |
|---|---|---|---|
groupName |
String | Yes |
The name of the microfrontends group that will be used to identify the group |
defaultApp |
Object | Yes |
The default app for the new microfrontend group |
defaultApp.projectId |
String | Yes |
The id of the project that will be used as the default app for the new microfrontend group |
defaultApp.defaultRoute |
String | No |
The default route for the default app of the new microfrontend group |
otherApplications[] |
Array | Yes |
The list of other applications that will be used in the new microfrontend group |
otherApplications[].projectId |
String | Yes |
The id of the project that will be used in the new microfrontend group |
otherApplications[].defaultRoute |
String | No |
The default route for the application in the new microfrontend group |
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.