Get microfrontends config for a deployment

APIs & SDKs

GET/__remote/api.vercel.com/v1/microfrontends/{deploymentId}/config

Get the microfrontends config for a deployment.

/__remote/api.vercel.com/v1/microfrontends/{deploymentId}/config

const response = await fetch('/__remote/api.vercel.com/v1/microfrontends/deploymentId/config?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "config": {
    "$schema": "string",
    "applications": "value",
    "options": {
      "disableOverrides": "false",
      "localProxyPort": "123"
    },
    "version": "1"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

deploymentIdstringRequired

The unique deployment identifier

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

configobjectRequired

projectIds are added when the config is uploaded to s3 deployment assets.

Errors

400One 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

500Error

/__remote/api.vercel.com/v1/microfrontends/{deploymentId}/config

const response = await fetch('/__remote/api.vercel.com/v1/microfrontends/deploymentId/config?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "config": {
    "$schema": "string",
    "applications": "value",
    "options": {
      "disableOverrides": "false",
      "localProxyPort": "123"
    },
    "version": "1"
  }
}

OpenAPI Specification