Skip to content
Docs

Get microfrontends config for a deployment

GEThttps://api.vercel.com/v1/microfrontends/{deploymentId}/config
Get the microfrontends config for a deployment.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.microfrontends.getMicrofrontendsConfig({
    deploymentId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "config": {
    "$schema": "string",
    "version": "1",
    "applications": "value",
    "options": {
      "disableOverrides": "false",
      "localProxyPort": "123"
    }
  }
}

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