Integrations
An integration ingests assets from a source platform — such as Snowflake, Databricks, BigQuery, or Microsoft Fabric — on a schedule or on demand. The Integrations API lets you inspect your integrations, review their ingestion runs, and trigger or cancel a run programmatically.
Integrations are created and configured in the UI (Studio → Assets → Manage Integrations); the
API is read-and-run only. Each integration is identified by its stable externalId, which is the
key used in all paths.
Endpoints
| Method & path | Description |
|---|---|
GET /api/integrations | List integrations visible to the API key. Filter by owningTeamExternalId, source, or enabled. Each item embeds its most recent run. |
GET /api/integrations/{externalId} | Get a single integration, including its provider configuration (credentials excluded). |
GET /api/integrations/{externalId}/runs | List past ingestion runs, most recent first. Filter by status; capped at 200. |
GET /api/integrations/{externalId}/runs/latest | Get the most recent ingestion run. |
GET /api/integrations/{externalId}/runs/{ingestionRunId} | Get a single ingestion run's status, asset counts, and timing. |
POST /api/integrations/{externalId}/run | Trigger a one-shot ingestion run. Returns 202 Accepted; 409 Conflict if a run is already in progress. |
POST /api/integrations/{externalId}/cancel | Request cancellation of the currently running ingestion. |
Triggering or cancelling a run requires INGESTION_EDIT on the integration's owning team, or
organization-owner privileges when the integration has no owning team.
An ingestion run moves through the statuses RUNNING → SUCCESS, FAILED, or CANCELLED. To wait
for a triggered run to finish, poll GET /api/integrations/{externalId}/runs/latest and watch the
status field.
curl --request POST \
https://api.entropy-data.com/api/integrations/demo-snowflake/run \
--header "x-api-key: $DMM_API_KEY"
OpenAPI Specification
Refer to the OpenAPI Specification for the full formal API documentation.