How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Lineage API

The `Lineage` for a given data asset, has information of the input datasets used and the ETL pipeline that created it.

OpenMetadata Lineage API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Lineage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 17 operations across 16 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

17 operations 16 paths 18 schemas 3 DELETE12 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Lineage API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 16 paths, the API surfaces 17 operations — 3 DELETE, 12 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Lineage 17

The Lineage for a given data asset, has information of the input datasets used and the ETL pipeline that created it.

PUT
/v1/lineage
Add a lineage edge
addLineageEdge body → 404
DELETE
/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}
Delete a lineage edge
deleteLineageEdge 4 params → 404
PATCH
/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}
Patch a lineage edge
patchLineageEdge 4 params body → 404
DELETE
/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}
Delete a lineage edge by FQNs
deleteLineageEdgeByName 4 params → 404
DELETE
/v1/lineage/{entityType}/{entityId}/type/{lineageSource}
Delete a lineage edge by Type
deleteLineageEdgeByType 3 params → 404
GET
/v1/lineage/export
Export lineage
exportLineage 6 params → 200
GET
/v1/lineage/exportAsync
Export lineage
exportLineage_1 6 params → 200
GET
/v1/lineage/exportByEntityCountAsync
Export lineage by entity count
exportLineageByEntityCount 12 params → 200
GET
/v1/lineage/{entity}/{id}
Get lineage by Id
getLineage 4 params → 200404
GET
/v1/lineage/{entity}/name/{fqn}
Get lineage by fully qualified name
getLineageByFQN 4 params → 200404
GET
/v1/lineage/getLineageByEntityCount
Get lineage with entity count based pagination
getLineageByEntityCount 15 params → 200
GET
/v1/lineage/getLineageEdge/{fromId}/{toId}
Get a lineage edge
getLineageEdge 2 params → 404
GET
/v1/lineage/getPaginationInfo
Get lineage pagination information
getLineagePaginationInfo 6 params → 200
GET
/v1/lineage/getDataQualityLineage
Search Data Quality lineage
searchDataQualityLineage 4 params → 200
GET
/v1/lineage/getPlatformLineage
Get Platform Lineage
getPlatformLineage 3 params → 200
GET
/v1/lineage/getLineage
Search lineage
searchLineage 11 params → 200
GET
/v1/lineage/getLineage/{direction}
Search lineage with Direction
searchLineageWithDirection 12 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are EsLineageData (17 properties), LineageDetails (11 properties), EntityReference (9 properties), CSVExportMessage (7 properties). Each schema is shown below with its type and property counts.

SearchLineageResult
object
4 properties
CSVExportMessage
object
7 properties
EntityLineage
object
4 properties 1 required
DepthInfo
object
2 properties 2 required
SearchResponse
object
LineagePaginationInfo
object
6 properties 6 required
LineageDetails
object
11 properties
TempLineageTable
object
2 properties 2 required
RelationshipRef
object
4 properties
LayerPaging
object
2 properties
EntityReference
object
9 properties 2 required
EsLineageData
object
17 properties
JsonPatch
object
AddLineage
object
1 property 1 required
Edge
object
4 properties 2 required
ColumnLineage
object
3 properties
NodeInformation
object
3 properties
EntitiesEdge
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-lineage-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Lineage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.