Create a microfrontends group with applications

APIs & SDKs

POST/__remote/api.vercel.com/v1/microfrontends/group

Creates a microfrontends group and attaches multiple projects in a single request.

/__remote/api.vercel.com/v1/microfrontends/group

const response = await fetch('/__remote/api.vercel.com/v1/microfrontends/group?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "groupName": "MFE Group 1",
    "defaultApp": {
      "projectId": "example_id",
      "defaultRoute": "string"
    },
    "otherApplications": [
      {
        "projectId": "example_id",
        "defaultRoute": "string"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "newMicrofrontendsGroup": {
    "createdAt": "123",
    "enablePolyrepoBranchRouting": "false",
    "fallbackEnvironment": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "slug": "string",
    "updatedAt": "123"
  }
}

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

groupNamestringRequired

The name of the microfrontends group that will be used to identify the group

defaultAppobjectRequired

The default app for the new microfrontend group

otherApplicationsarrayRequired

The list of other applications that will be used in the new microfrontend group

Response

200Success

newMicrofrontendsGroupobjectRequired

Errors

400One of the provided values in the request body is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

500Error

/__remote/api.vercel.com/v1/microfrontends/group

const response = await fetch('/__remote/api.vercel.com/v1/microfrontends/group?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "groupName": "MFE Group 1",
    "defaultApp": {
      "projectId": "example_id",
      "defaultRoute": "string"
    },
    "otherApplications": [
      {
        "projectId": "example_id",
        "defaultRoute": "string"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "newMicrofrontendsGroup": {
    "createdAt": "123",
    "enablePolyrepoBranchRouting": "false",
    "fallbackEnvironment": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "slug": "string",
    "updatedAt": "123"
  }
}

OpenAPI Specification