Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ExternalServicesSettings

Represents settings for an External Services registration.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

ExternalServicesSettings values are stored in the externalServicesSettings.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version

ExternalServicesSettings components are available in API version 47.0 to 55.0. This metadata type is removed in version 56.0 and later.

As of Winter ’23, External Services automatically validates the schema and provides detailed messages for any errors in the UI at registration time so that you can make corrections. See Register an External Service in Salesforce Help.

Fields

Field Name	Description
enableIgnoreUnsupportedOperations	Field Type boolean Description Indicates whether your registration should ignore and filter out unsupported schema operations rather than fail the entire registration (`true`), or whether a specification with invalid schema operations can't be registered successfully (`false`). Detailed schema errors pertaining to unsupported operations are shown only if this flag is `false`.

Declarative Metadata Sample Definition

The following is an example of an ExternalServicesSettings component.

The following is an example package.xml that references the previous definition.

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide