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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMetadata

OpenMetadata Domains API

A `Data Product` or `Data as a Product` is a logical unit that contains all components to process and store domain data for analytical or data-intensive use cases made available to data consumers.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 58 operations across 48 paths, and defines 59 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.

58 operations 48 paths 59 schemas 8 DELETE26 GET4 PATCH2 POST18 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
Contact
OpenMetadata
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 58

Across 48 paths, the API surfaces 58 operations — 8 DELETE, 26 GET, 4 PATCH, 2 POST, 18 PUT. Each is listed below with its method, path, parameters, and response codes.

Domains 58

A Data Product or Data as a Product is a logical unit that contains all components to process and store domain data for analytical or data-intensive use cases made available to da…

PUT
/v1/dataProducts/{id}/followers
Add a follower
addFollowerToDataProduct 1 param body → 200404
PUT
/v1/dataProducts/{name}/assets/add
Bulk Add Assets
bulkAddAssets 1 param body → 200400404
PUT
/v1/dataProducts/{name}/inputPorts/add
Bulk Add Input Ports
bulkAddInputPorts 1 param body → 200400404
PUT
/v1/dataProducts/name/{fqn}/inputPorts/add
Bulk Add Input Ports by Name
bulkAddInputPortsByName 1 param body → 200400404
PUT
/v1/dataProducts/{name}/outputPorts/add
Bulk Add Output Ports
bulkAddOutputPorts 1 param body → 200400404
PUT
/v1/dataProducts/name/{fqn}/outputPorts/add
Bulk Add Output Ports by Name
bulkAddOutputPortsByName 1 param body → 200400404
PUT
/v1/dataProducts/{name}/assets/remove
Bulk Remove Assets
bulkRemoveAssets 1 param body → 200400404
PUT
/v1/dataProducts/{name}/inputPorts/remove
Bulk Remove Input Ports
bulkRemoveInputPorts 1 param body → 200400404
PUT
/v1/dataProducts/name/{fqn}/inputPorts/remove
Bulk Remove Input Ports by Name
bulkRemoveInputPortsByName 1 param body → 200400404
PUT
/v1/dataProducts/{name}/outputPorts/remove
Bulk Remove Output Ports
bulkRemoveOutputPorts 1 param body → 200400404
PUT
/v1/dataProducts/name/{fqn}/outputPorts/remove
Bulk Remove Output Ports by Name
bulkRemoveOutputPortsByName 1 param body → 200400404
GET
/v1/dataProducts
List dataProducts
listDataProducts 5 params → 200
PUT
/v1/dataProducts
Create or update a dataProduct
createOrUpdateDataProduct body → 200400
POST
/v1/dataProducts
Create a dataProduct
createDataProduct body → 200400
GET
/v1/dataProducts/name/{name}
Get a dataProduct by name
getDataProductByFQN 2 params → 200404
DELETE
/v1/dataProducts/name/{name}
Delete a dataProduct by name
deleteDataProductByFQN 1 param → 200404
GET
/v1/dataProducts/{id}
Get a dataProduct by Id
getDataProductByID 2 params → 200404
DELETE
/v1/dataProducts/{id}
Delete a dataProduct by Id
deleteDataProduct 1 param → 200404
PATCH
/v1/dataProducts/{id}
Update a dataProduct
patchDataProduct_1 1 param body → default
DELETE
/v1/dataProducts/async/{id}
Asynchronously delete a dataProduct by Id
deleteDataProductAsync 1 param → 200404
DELETE
/v1/dataProducts/{id}/followers/{userId}
Remove a follower
deleteFollowerFromDataProduct 2 params → 200
GET
/v1/dataProducts/assets/counts
Get all data products with their asset counts
getAllDataProductsWithAssetsCount → 200
GET
/v1/dataProducts/{id}/assets
Get assets for a data product
getDataProductAssets 3 params → 200404
GET
/v1/dataProducts/name/{fqn}/assets
Get assets for a data product by name
getDataProductAssetsByName 3 params → 200404
GET
/v1/dataProducts/{id}/dataContract
Get data contract for a data product
getDataProductContract 2 params → 200404
GET
/v1/dataProducts/{id}/inputPorts
Get input ports for a data product
getInputPorts 4 params → 200404
GET
/v1/dataProducts/name/{fqn}/inputPorts
Get input ports for a data product by name
getInputPortsByName 4 params → 200404
GET
/v1/dataProducts/{id}/outputPorts
Get output ports for a data product
getOutputPorts 4 params → 200404
GET
/v1/dataProducts/name/{fqn}/outputPorts
Get output ports for a data product by name
getOutputPortsByName 4 params → 200404
GET
/v1/dataProducts/{id}/portsView
Get combined input/output ports view for a data product
getPortsView 6 params → 200404
GET
/v1/dataProducts/name/{fqn}/portsView
Get combined input/output ports view for a data product by name
getPortsViewByName 6 params → 200404
GET
/v1/dataProducts/{id}/versions/{version}
Get a version of the dataProduct
listSpecificDataProductVersion 2 params → 200404
GET
/v1/dataProducts/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_19 5 params → 200
GET
/v1/dataProducts/{id}/versions
List dataProduct versions
listAllDataProductVersion 1 param → 200
PATCH
/v1/dataProducts/name/{fqn}
Update a dataProduct by name.
patchDataProduct 1 param body → default
PUT
/v1/dataProducts/{id}/vote
Update Vote for an Entity
updateVoteForEntity_7 1 param body → 200404
PUT
/v1/domains/{id}/followers
Add a follower
addFollowerToDomain 1 param body → 200404
PUT
/v1/domains/{name}/assets/add
Bulk Add Assets
bulkAddAssets_1 1 param body → 200404
PUT
/v1/domains/{name}/assets/remove
Bulk Remove Assets
bulkRemoveAssets_1 1 param body → 200404
GET
/v1/domains
List domains
listDomains 4 params → 200
PUT
/v1/domains
Create or update a domain
createOrUpdateDomain body → 200400
POST
/v1/domains
Create a domain
createDomain body → 200400
GET
/v1/domains/name/{name}
Get a domain by name
getDomainByFQN 2 params → 200404
DELETE
/v1/domains/name/{name}
Delete a domain by name
deleteDomainByFQN 1 param → 200404
GET
/v1/domains/{id}
Get a domain by Id
getDomainByID 2 params → 200404
DELETE
/v1/domains/{id}
Delete a domain by Id
deleteDomain 1 param → 200404
PATCH
/v1/domains/{id}
Update a domain
patchDomain_1 1 param body → default
DELETE
/v1/domains/async/{id}
Asynchronously delete a domain by Id
deleteDomainAsync 1 param → 200404
DELETE
/v1/domains/{id}/followers/{userId}
Remove a follower
deleteFollowerFromDomain 2 params → 200
GET
/v1/domains/assets/counts
Get all domains with their asset counts
getAllDomainsWithAssetsCount → 200
GET
/v1/domains/{id}/assets
Get assets for a domain
getDomainAssets 3 params → 200404
GET
/v1/domains/name/{fqn}/assets
Get assets for a domain by name
getDomainAssetsByName 3 params → 200404
GET
/v1/domains/{id}/versions/{version}
Get a version of the domain
listSpecificDomainVersion 2 params → 200404
GET
/v1/domains/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_20 5 params → 200
GET
/v1/domains/hierarchy
List domains in hierarchical order
listDomainsHierarchy 4 params → 200
GET
/v1/domains/{id}/versions
List domain versions
listAllDomainVersion 1 param → 200
PATCH
/v1/domains/name/{fqn}
Update a domain by name.
patchDomain 1 param body → default
PUT
/v1/domains/{id}/vote
Update Vote for an Entity
updateVoteForEntity_8 1 param body → 200404

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are DataContract (48 properties), Policy (39 properties), DataProduct (36 properties), Domain (35 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ColumnProfile
object
30 properties 2 required
SlaDefinition
object
5 properties
BulkOperationResult
object
8 properties
ODCSAuthoritativeDefinition
object
3 properties
TermsOfUse
object
2 properties
ContractSLA
object
7 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
Retention
object
2 properties 2 required
LifeCycle
object
3 properties
DataProductList
object
5 properties 1 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
CustomMetricProfile
object
2 properties
Domain
object
35 properties 4 required
CardinalityDistribution
object
4 properties
EntityHierarchyList
object
5 properties 1 required
ResultList
object
5 properties 1 required
VoteRequest
object
1 property
BulkResponse
object
3 properties
CreateDomain
object
15 properties 3 required
Paging
object
5 properties 1 required
JsonPatch
object
CustomMetric
object
8 properties 2 required
DataProductPortsView
object
3 properties 3 required
ChangeDescription
object
5 properties
ODCSQualityRule
object
27 properties
PaginatedEntities
object
2 properties 2 required
DataProduct
object
36 properties 3 required
LatestResult
object
4 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
CreateDataProduct
object
14 properties 3 required
RefreshFrequency
object
2 properties 2 required
BulkAssets
object
2 properties
Style
object
3 properties
Column
object
18 properties 2 required
Datum
object
CustomProperties
object
Votes
object
4 properties
EntityHierarchy
object
6 properties 3 required
Histogram
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
ContractUpdate
object
5 properties 3 required
Policy
object
39 properties 3 required
MaxLatency
object
2 properties 2 required
DomainList
object
5 properties 1 required
SemanticsRule
object
9 properties 4 required
EntityReference
object
9 properties 2 required
DataContract
object
48 properties 3 required
ContractSecurity
object
3 properties
UsageDetails
object
4 properties 2 required
Rule
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-domains-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
AE Profile APIs.io
OpenMetadata AI Applications API
AE Profile APIs.io
OpenMetadata AI Governance Policies API
AE Profile APIs.io
OpenMetadata API Collections API
AE Profile APIs.io
OpenMetadata API Endpoint API
AE Profile APIs.io
OpenMetadata API Services API
AE Profile APIs.io
OpenMetadata Apps API
AE Profile APIs.io
OpenMetadata Audit Logs API
AE Profile APIs.io
OpenMetadata Bots API
AE Profile APIs.io
OpenMetadata ChangeSummary API
AE Profile APIs.io
OpenMetadata Charts API
AE Profile APIs.io
OpenMetadata Classifications API
AE Profile APIs.io
#Domains
← Back to O APIs
API Details
ID
openmetadata:openmetadata-domains-api
Base URL
https://{your-host}/api/v1
Docs
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
Provider
OpenMetadata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmetadata-domains-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-domains-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenMetadata Domains 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.