Skip to main content
Integrations represent extractors and other data pipelines that CDF monitors. Each integration tracks the tasks it runs, the errors it reports, and whether the extractor is running. You can create, list, retrieve, update, and delete integrations. An integration is a record of an extractor or other process that sends data to CDF. It identifies the extractor type and holds the configuration, task history, and error history for that data pipeline. Tasks, actions, configuration, and errors are all scoped to an integration.

​
Managing integrations

You can create integrations when you set up a new extractor, and update them as the extractor’s details change. Use list and retrieve to find integrations by ID and inspect their current state. Delete an integration when the extractor it represents is decommissioned.
Deleting an integration removes it from monitoring. After you delete it, you cannot retrieve its task and error history.

​
Key operations

  • Create: Register a new integration for an extractor or data pipeline.
  • List and retrieve: Find integrations and inspect their details.
  • Update: Modify integration metadata as the extractor changes.
  • Delete: Remove an integration that is no longer in use.
  • Startup: Report the extractor’s type, version, and configured tasks when it starts.
  • Check in: Report task and error updates periodically, and receive the active configuration revision and pending actions.
Integrations are the anchor that task history, actions, configuration, and errors are all reported against.

​
Extractor startup and check-in

Extractors report that they are running directly to the integration record. On startup, an extractor reports its type, version, and configured tasks. It also closes any tasks still marked as running from a previous session. After that, it checks in periodically. Check-in reports task starts, stops, and errors, and returns the latest configuration revision and any pending actions.
Startup and check-in require the integrationsAcl:USE capability, a separate scope from the READ and WRITE capabilities used by the other integration operations. Only the extractor’s own credentials should have USE for an integration. Reporting status on behalf of an integration you do not operate overwrites its real running status, task history, and error history with incorrect data.
Last modified on September 25, 2026