ExperienceBundleSettings

Represents the org setting that enables the ExperienceBundle metadata type for Aura sites in Experience Cloud. The setting doesn’t affect LWR sites, which use ExperienceBundle by default. This type extends the Metadata metadata type and inherits its fullName field.

ExperienceBundle is a text-based code structure of the settings and site components, such as pages, branding sets, and themes, that make up an Experience Builder site. Developers can quickly update and deploy one or more Experience Builder sites programmatically using their preferred development tools.

Note

File Suffix and Directory Location

ExperienceBundleSettings values are stored in a single file named ExperienceBundle.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

ExperienceBundleSettings is available in API version 46.0 and later.

Fields

Field Name	Field Type	Description
enableExperienceBundleMetadata	boolean	Indicates whether the ExperienceBundle metadata type is enabled for Aura sites. Default is `false`. LWR sites use ExperienceBundle by default.

Declarative Metadata Sample Definition

Here’s an example of ExperienceBundle.settings that references the previous definition.

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide