Which DataHub API is for me?

DataHub supplys several APIs to manipulate metadata on the platform. These are our most-to-least recommended approaches:

• Our most recommended tools for extending and customizing the behavior of your DataHub instance are our SDKs in Python and Java.
• If you'd like to customize the DataHub client or roll your own; the GraphQL API is our what powers our frontend. We figure if it's good enough for us, it's good enough for everyone! If graphql doesn't cover everything in your usecase, drop into our slack and let us know how we can improve it!
• If you are less familiar with graphql and would rather use OpenAPI, we offer OpenAPI endpoints that allow you to produce metadata events and query metadata.
• Finally, if you're a brave soul and know exactly what you are doing... are you sure you don't just want to use the SDK directly? If you insist, the Rest.li API is a much more powerful, low level API intended only for advanced users.

Python and Java SDK

We offer an SDK for both Python and Java that provide full functionality when it comes to CRUD operations and any complex functionality you may want to build into DataHub.

Get started with the Python SDKGet started with the Java SDK

GraphQL API

The graphql API serves as the primary public API for the platform. It can be used to fetch and update metadata programatically in the language of your choice. Intended as a higher-level API that simplifies the most common operations.

Get started with the GraphQL API

OpenAPI

For developers who prefer OpenAPI to GraphQL for programmatic operations. Provides lower-level API access to the entire DataHub metadata model for writes, reads and queries.

Get started with OpenAPI

Rest.li API

caution

The Rest.li API is intended only for advanced users. If you're just getting started with DataHub, we recommend the GraphQL API

The Rest.li API represents the underlying persistence layer, and exposes the raw PDL models used in storage. Under the hood, it powers the GraphQL API. Aside from that, it is also used for system-specific ingestion of metadata, being used by the Metadata Ingestion Framework for pushing metadata into DataHub directly. For all intents and purposes, the Rest.li API is considered system-internal, meaning DataHub components are the only ones to consume this API directly.

Get started with our Rest.li API

DataHub API Comparison

DataHub supports several APIs, each with its own unique usage and format. Here's an overview of what each API can do.

Last Updated : Apr 8 2023

Feature	GraphQL	Python SDK	OpenAPI
Create a dataset	🚫	✅ [Guide]	✅
Delete a dataset (Soft delete)	✅ [Guide]	✅ [Guide]	✅
Delete a dataset (Hard delele)	🚫	✅ [Guide]	✅
Search a dataset	✅	✅	✅
Create a tag	✅ [Guide]	✅ [Guide]	✅
Read a tag	✅ [Guide]	✅ [Guide]	✅
Add tags to a dataset	✅ [Guide]	✅ [Guide]	✅
Add tags to a column of a dataset	✅ [Guide]	✅ [Guide]	✅
Remove tags from a dataset	✅ [Guide]	✅ [Guide]	✅
Create glossary terms	✅ [Guide]	✅ [Guide]	✅
Read terms from a dataset	✅ [Guide]	✅ [Guide]	✅
Add terms to a column of a dataset	✅ [Guide]	✅ [Guide]	✅
Add terms to a dataset	✅ [Guide]	✅ [Guide]	✅
Create domains	✅ [Guide]	✅ [Guide]	✅
Read domains	✅ [Guide]	✅ [Guide]	✅
Add domains to a dataset	✅ [Guide]	✅ [Guide]	✅
Remove domains from a dataset	✅ [Guide]	✅ [Guide]	✅
Crate users and groups	✅ [Guide]	✅ [Guide]	✅
Read owners of a dataset	✅ [Guide]	✅ [Guide]	✅
Add owner to a dataset	✅ [Guide]	✅ [Guide]	✅
Remove owner from a dataset	✅ [Guide]	✅ [Guide]	✅
Add lineage	✅ [Guide]	✅ [Guide]	✅
Add column level(Fine Grained) lineage	🚫	✅	✅
Add documentation(description) to a column of a dataset	✅ [Guide]	✅ [Guide]	✅
Add documentation(description) to a dataset	✅ [Guide]	✅ [Guide]	✅
Add / Remove / Replace custom properties on a dataset	🚫 [Guide]	✅ [Guide]	✅