group_projects

Creates, updates, deletes, gets or lists a group_projects resource.

Overview

Name	group_projects
Type	Resource
Id	vercel.microfrontends.group_projects

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string
name	string
account_id	string	(wire: accountId)
connect_configuration_id	string	(wire: connectConfigurationId)
passive_connect_configuration_id	string	(wire: passiveConnectConfigurationId)
transfer_to_account_id	string	(wire: transferToAccountId)
transferred_from_account_id	string	(wire: transferredFromAccountId)
concurrency_bucket_name	string	(wire: concurrencyBucketName)
abuse	object
alias	array
analytics	object
applied_cve_55182_migration	boolean	(false, true) (wire: appliedCve55182Migration)
auto_assign_custom_domains	boolean	(false, true) (wire: autoAssignCustomDomains)
auto_assign_custom_domains_updated_by	string	(wire: autoAssignCustomDomainsUpdatedBy)
auto_expose_system_envs	boolean	(false, true) (wire: autoExposeSystemEnvs)
avatar	string
blobs	object
build_command	string	(wire: buildCommand)
command_for_ignoring_build_step	string	(wire: commandForIgnoringBuildStep)
connect_builds_enabled	boolean	(false, true) (wire: connectBuildsEnabled)
connect_configurations	array	(wire: connectConfigurations)
created_at	number	(wire: createdAt)
creator
crons	object
custom_environments	array	(wire: customEnvironments)
customer_support_code_visibility	boolean	(false, true) (wire: customerSupportCodeVisibility)
data_cache	object	(wire: dataCache)
default_resource_config	object	(wire: defaultResourceConfig)
deployment_expiration	object	Retention policies for deployments. These are enforced at the project level, but we also maintain an instance of this at the team level as a default policy that gets applied to new projects. (wire: deploymentExpiration)
deployment_policy	object	Project shape. null on a rule list clears the project's override for that rule type (fall back to team for every env); omitting is equivalent. Setting deploymentPolicy itself to null clears every override at once. Kept structurally distinct from {@link TeamDeploymentPolicy} so the two storage locations don't share a type by accident. (wire: deploymentPolicy)
dev_command	string	(wire: devCommand)
directory_listing	boolean	(false, true) (wire: directoryListing)
dismissed_toasts	array	(wire: dismissedToasts)
enable_affected_projects_deployments	boolean	(false, true) (wire: enableAffectedProjectsDeployments)
enable_external_rewrite_caching	boolean	(false, true) (wire: enableExternalRewriteCaching)
enable_preview_feedback	boolean	(false, true, ) (wire: enablePreviewFeedback)
enable_production_feedback	boolean	(false, true, ) (wire: enableProductionFeedback)
env	array
expiration
features	object
framework	string	(actix-web, angular, ash, astro, axum, blitzjs, brunch, bun, container, create-react-app, django, docusaurus, docusaurus-2, dojo, eleventy, elysia, ember, eve, express, factory-eve, fastapi, fasthtml, fastify, flask, gatsby, go, gridsome, h3, hexo, hono, hugo, hydrogen, ionic-angular, ionic-react, jekyll, koa, mastra, middleman, nestjs, nextjs, nitro, node, nuxtjs, parcel, polymer, preact, python, react-router, redwoodjs, remix, ruby, rust, saber, sanity, sanity-v2, sapper, scully, services, solidstart, solidstart-1, stencil, storybook, svelte, sveltekit, sveltekit-1, tanstack-start, tanstack-start-lovable, umijs, vite, vitepress, vue, vuepress, xmcp, zola, )
git_comments	object	(wire: gitComments)
git_fork_protection	boolean	(false, true) (wire: gitForkProtection)
git_lfs	boolean	(false, true) (wire: gitLFS)
git_provider_options	object	(wire: gitProviderOptions)
has_active_branches	boolean	(false, true) (wire: hasActiveBranches)
has_deployments	boolean	(false, true) (wire: hasDeployments)
install_command	string	(wire: installCommand)
internal_routes	array	(wire: internalRoutes)
ip_buckets	array	(wire: ipBuckets)
jobs	object
last_alias_request	object	(wire: lastAliasRequest)
last_rollback_target	string	(opaque JSON object) (wire: lastRollbackTarget)
latest_deployments	array	(wire: latestDeployments)
link
live	boolean	(false, true)
microfrontends
node_version	string	(10.x, 12.x, 14.x, 16.x, 18.x, 20.x, 22.x, 24.x, 8.10.x) (wire: nodeVersion)
oidc_token_config	object	(wire: oidcTokenConfig)
options_allowlist	object	(wire: optionsAllowlist)
output_directory	string	(wire: outputDirectory)
passport	object
password_protection	string	(opaque JSON object) (wire: passwordProtection)
paused	boolean	(false, true)
permissions	object
production_deployments_fast_lane	boolean	(false, true) (wire: productionDeploymentsFastLane)
protected_sourcemaps	boolean	(false, true) (wire: protectedSourcemaps)
protection_bypass	object	(wire: protectionBypass)
protection_config	object	(wire: protectionConfig)
resource_config	object	(wire: resourceConfig)
rollback_description	object	Description of why a project was rolled back, and by whom. Note that lastAliasRequest contains the from/to details of the rollback. (wire: rollbackDescription)
rolling_release	object	Project-level rolling release configuration that defines how deployments should be gradually rolled out (wire: rollingRelease)
root_directory	string	(wire: rootDirectory)
sandbox	object
security	object
serverless_function_zero_config_failover	boolean	(false, true) (wire: serverlessFunctionZeroConfigFailover)
services	array
skew_protection_allowed_domains	array	(wire: skewProtectionAllowedDomains)
skew_protection_boundary_at	number	(wire: skewProtectionBoundaryAt)
skew_protection_max_age	number	(wire: skewProtectionMaxAge)
skip_git_connect_during_link	boolean	(false, true) (wire: skipGitConnectDuringLink)
source_files_outside_root_directory	boolean	(false, true) (wire: sourceFilesOutsideRootDirectory)
speed_insights	object	(wire: speedInsights)
sso_protection	object	(wire: ssoProtection)
static_ips	object	(wire: staticIps)
targets	object
tier	string	(advanced, critical, priority)
tracing	object
transfer_completed_at	number	(wire: transferCompletedAt)
transfer_started_at	number	(wire: transferStartedAt)
trusted_ips		(wire: trustedIps)
trusted_sources	object	(wire: trustedSources)
updated_at	number	(wire: updatedAt)
usage_status	object	(wire: usageStatus)
v_0	boolean	(false, true) (wire: v0)
v_0_created	boolean	(false, true) (wire: v0Created)
web_analytics	object	(wire: webAnalytics)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	group_id	team_id, slug	Get the microfrontends for a given group ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_id	string
slug	string	The Team slug to perform the request on behalf of.
team_id	string	The Team identifier to perform the request on behalf of. (wire: teamId)

SELECT examples

list

Get the microfrontends for a given group ID.

SELECT
id,
name,
account_id,
connect_configuration_id,
passive_connect_configuration_id,
transfer_to_account_id,
transferred_from_account_id,
concurrency_bucket_name,
abuse,
alias,
analytics,
applied_cve_55182_migration,
auto_assign_custom_domains,
auto_assign_custom_domains_updated_by,
auto_expose_system_envs,
avatar,
blobs,
build_command,
command_for_ignoring_build_step,
connect_builds_enabled,
connect_configurations,
created_at,
creator,
crons,
custom_environments,
customer_support_code_visibility,
data_cache,
default_resource_config,
deployment_expiration,
deployment_policy,
dev_command,
directory_listing,
dismissed_toasts,
enable_affected_projects_deployments,
enable_external_rewrite_caching,
enable_preview_feedback,
enable_production_feedback,
env,
expiration,
features,
framework,
git_comments,
git_fork_protection,
git_lfs,
git_provider_options,
has_active_branches,
has_deployments,
install_command,
internal_routes,
ip_buckets,
jobs,
last_alias_request,
last_rollback_target,
latest_deployments,
link,
live,
microfrontends,
node_version,
oidc_token_config,
options_allowlist,
output_directory,
passport,
password_protection,
paused,
permissions,
production_deployments_fast_lane,
protected_sourcemaps,
protection_bypass,
protection_config,
resource_config,
rollback_description,
rolling_release,
root_directory,
sandbox,
security,
serverless_function_zero_config_failover,
services,
skew_protection_allowed_domains,
skew_protection_boundary_at,
skew_protection_max_age,
skip_git_connect_during_link,
source_files_outside_root_directory,
speed_insights,
sso_protection,
static_ips,
targets,
tier,
tracing,
transfer_completed_at,
transfer_started_at,
trusted_ips,
trusted_sources,
updated_at,
usage_status,
v_0,
v_0_created,
web_analytics
FROM vercel.microfrontends.group_projects
WHERE group_id = '{{ group_id }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;