The OpenLineage Integration API provides a standard HTTP interface for receiving lineage events from OpenLineage-compatible orchestration tools. It acts as a passive receiver, accepting OpenLineage RunEvent payloads and processing them to create and update assets and lineage relationships.
The API follows the official OpenLineage HTTP transport specification and supports idempotent event ingestion, where duplicate events (based on the same runId and eventType) are safely ignored.
In addition to the standard ingestion endpoint, the API includes Data Catalog management endpoints that allow clients to query and access stored OpenLineage data. These endpoints support retrieving events, runs, jobs, and configuration data for use in product surfaces and integrations.
Workflow
- An OpenLineage-compatible producer sends a lineage event.
- The API receives the event at
POST /api/v1/lineage. - The API accepts the OpenLineage RunEvent and processes it to create or update assets and lineage relationships.
Methods
The API provides endpoints to receive OpenLineage events and to access stored OpenLineage data. These methods support event ingestion as well as retrieving and working with events, runs, jobs, and configuration data.
OpenLineage
- POST Receive OpenLineage event (standard endpoint)
- Standard OpenLineage HTTP Transport Endpoint Accepts an OpenLineage RunEvent and processes it to create/update assets and lineage relations.
OpenLineage Management
- GET Query OpenLineage events
- Data Catalog Management Endpoint Returns a paginated list of OpenLineage events with optional filters.
- GET Get single OpenLineage event
- Returns a single OpenLineage event by its ID
- GET Get OpenLineage run details
- Returns run details including all events and resolved asset IDs
- GET List tracked OpenLineage jobs
- Returns a list of all OpenLineage jobs tracked in the workspace
OpenLineage Configuration
- GET List asset type hierarchy configurations
- Returns all configured asset type hierarchy mappings for the workspace, including both system defaults and custom configurations.
- POST Create custom hierarchy configuration
- Create a new asset type hierarchy configuration for a namespace prefix.
- GET Get single hierarchy configuration
- Get single hierarchy configuration
- PATCH Update hierarchy configuration
- Update an existing hierarchy configuration.
- DELETE Delete hierarchy configuration
- Delete a custom hierarchy configuration.
- POST Validate hierarchy configuration (dry-run)
- Validate a hierarchy configuration without persisting it.
- POST Reset namespace to system default
- Delete any workspace-specific override for a namespace and restore the system default configuration.