Update a microfrontends group | Edgenivo REST API

APIs & SDKs

Update a microfrontends group

PATCH/__remote/api.vercel.com/v1/teams/{teamId}/microfrontends/{groupId}

Updates a microfrontends group's settings.

/__remote/api.vercel.com/v1/teams/{teamId}/microfrontends/{groupId}

const response = await fetch('/__remote/api.vercel.com/v1/teams/teamId/microfrontends/groupId?slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "MFE Group 1",
    "fallbackEnvironment": "string",
    "enablePolyrepoBranchRouting": "true"
  }),
});

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

Response

{
  "updatedMicrofrontendsGroup": {
    "enablePolyrepoBranchRouting": "false",
    "fallbackEnvironment": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "slug": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

groupIdstringRequired

teamIdstringRequired

The Team identifier to perform the request on behalf of.

Query parameters

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

namestringOptional

The new name for the existing microfrontends group.

fallbackEnvironmentstringOptional

The new fallback environment for the microfrontends group. Must be "SAME_ENV", "PRODUCTION", or a valid custom environment slug from the default app.

enablePolyrepoBranchRoutingbooleanOptional

Whether Preview Deployments can link to branches with the same name in other Git repositories.

Response

200Success

updatedMicrofrontendsGroupobjectRequired

Errors

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

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

/__remote/api.vercel.com/v1/teams/{teamId}/microfrontends/{groupId}

const response = await fetch('/__remote/api.vercel.com/v1/teams/teamId/microfrontends/groupId?slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "MFE Group 1",
    "fallbackEnvironment": "string",
    "enablePolyrepoBranchRouting": "true"
  }),
});

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

Response

{
  "updatedMicrofrontendsGroup": {
    "enablePolyrepoBranchRouting": "false",
    "fallbackEnvironment": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "slug": "string"
  }
}

OpenAPI Specification