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.

DataConnectorIngestApi

Represents the connection information specific to Ingestion API.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

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

File Suffix and Directory Location

DataConnectorIngestApi components have the suffix .dataConnectorIngestApi and are stored in the dataConnectorIngestApis folder.

Version

DataConnectorIngestApi components are available in API version 54.0 and later.

Special Access Rules

You must have the CustomizeApplication user permissions to access the DataConnectorIngestApi type.

Fields

Field Name	Description
masterLabel	Field Type string Description Required. UI label of the Ingestion API Connector.
sourceName	Field Type string Description Required. Name of the Ingestion API Connector.

Declarative Metadata Sample Definition

The following is an example of a DataConnectorIngestApi component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
3    <sourceName>CONNECTOR NAME</sourceName>
4    <masterLabel>CONNECTOR NAME</masterLabel>
5</DataConnectorIngestApi>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<DataConnectorIngestApi xmlns="http://soap.sforce.com/2006/04/metadata">
3    <sourceName>MyConnector</sourceName>
4    <masterLabel>MyConnector</masterLabel>
5</DataConnectorIngestApi>

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