externalId.
This API is enabled per project. If requests return that the endpoint isn’t enabled, contact Cognite Support.
Concepts
- Source type — The external system the source connects to. The supported value is
one_lakefor Microsoft Fabric OneLake. - Credentials — Microsoft Entra ID application credentials:
clientId,tenantId, andclientSecret. The client secret is write-only; it is stored encrypted and never returned when you read a data source. - Location — Where in OneLake the source points:
workspaceIdandcontainerId, both as GUIDs. - Data set scoping — Optional
dataSetIdthat scopes access to the data source through CDF data set permissions.
Usability checks
Before you use an external data source in a transformation, call the usability endpoint (POST /transformations/externaldata/usability) to verify that CDF can reach the storage location with the stored credentials. The response reports whether the connection and permissions succeed, so you can fix configuration issues before a transformation job fails.
Key capabilities
- List external data sources configured for the project
- Create external data sources with a unique
externalId - Delete external data sources by
idorexternalId - Verify usability of a data source before using it in a transformation
If the
externalId already exists in the project, POST /transformations/externaldata returns 409 and creates no items. To change a source, delete it and create a replacement. There is no update operation.The stable (
20230101) API reference does not include external data sources. Use the beta or alpha API reference for concepts and endpoint documentation. Send Cdf-Version: beta on requests. For how preview APIs relate to stable, see Beta API reference.