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 Data Contracts API

`DataContract` defines the schema and quality guarantees for a data asset.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 34 operations across 26 paths, and defines 67 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.

34 operations 26 paths 67 schemas 5 DELETE14 GET1 PATCH9 POST5 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 Data Contracts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 34

Across 26 paths, the API surfaces 34 operations — 5 DELETE, 14 GET, 1 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Data Contracts 34

DataContract defines the schema and quality guarantees for a data asset.

GET
/v1/dataContracts
List data contracts
listDataContracts 7 params → 200
PUT
/v1/dataContracts
Create or update a data contract from YAML
createOrUpdateDataContractFromYaml body → 200
POST
/v1/dataContracts
Create a data contract from YAML
createDataContractFromYaml body → 200400
PUT
/v1/dataContracts/odcs
Create or update data contract from ODCS format
createOrUpdateDataContractFromODCS 4 params body → 200400
POST
/v1/dataContracts/odcs
Import data contract from ODCS format
importDataContractFromODCS 3 params body → 200400
PUT
/v1/dataContracts/odcs/yaml
Create or update data contract from ODCS YAML format
createOrUpdateDataContractFromODCSYaml 4 params body → 200400
POST
/v1/dataContracts/odcs/yaml
Import data contract from ODCS YAML format
importDataContractFromODCSYaml 3 params body → 200400
GET
/v1/dataContracts/{id}/results
List data contract results
listDataContractResults 4 params → 200
PUT
/v1/dataContracts/{id}/results
Create or update data contract result
createOrUpdateDataContractResult 1 param body → 200
GET
/v1/dataContracts/{id}
Get a data contract by id
getDataContractByID 4 params → 200404
DELETE
/v1/dataContracts/{id}
Delete a data contract by id
deleteDataContract 3 params → 200404
PATCH
/v1/dataContracts/{id}
Update a data contract
patchDataContract 1 param body → default
DELETE
/v1/dataContracts/async/{id}
Delete a data contract by id asynchronously
deleteDataContractAsync 3 params → 200404
GET
/v1/dataContracts/name/{fqn}
Get a data contract by fully qualified name
getDataContractByFQN 4 params → 200404
DELETE
/v1/dataContracts/name/{fqn}
Delete a data contract by fully qualified name
deleteDataContractByName 3 params → 200404
DELETE
/v1/dataContracts/{id}/results/{timestamp}
Delete data contract result
deleteDataContractResult 2 params → 200
DELETE
/v1/dataContracts/{id}/results/before/{timestamp}
Delete data contract results before timestamp
deleteDataContractResultsBefore 2 params → 200
GET
/v1/dataContracts/{id}/odcs
Export data contract to ODCS format
exportDataContractToODCS 2 params → 200404
GET
/v1/dataContracts/name/{fqn}/odcs
Export data contract to ODCS format by FQN
exportDataContractToODCSByFQN 2 params → 200404
GET
/v1/dataContracts/{id}/odcs/yaml
Export data contract to ODCS YAML format
exportDataContractToODCSYaml 2 params → 200404
GET
/v1/dataContracts/name/{fqn}/odcs/yaml
Export data contract to ODCS YAML format by FQN
exportDataContractToODCSYamlByFQN 2 params → 200404
GET
/v1/dataContracts/entity
Get the effective data contract for an entity
getDataContractByEntityId 3 params → 200404
GET
/v1/dataContracts/{id}/results/latest
Get latest data contract result
getLatestDataContractResult 1 param → 200404
GET
/v1/dataContracts/{id}/results/{resultId}
Get a data contract result by ID
getDataContractResult 2 params → 200404
GET
/v1/dataContracts/{id}/versions/{version}
Get a version of a data contract
getDataContractVersion 2 params → 200404
GET
/v1/dataContracts/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_12 5 params → 200
GET
/v1/dataContracts/{id}/versions
List all versions of a data contract
listDataContractVersions 1 param → 200
POST
/v1/dataContracts/odcs/parse/yaml
Parse ODCS YAML and return metadata
parseODCSYaml body → 200400
PUT
/v1/dataContracts/restore
Restore a soft deleted data contract
restore_11 body → 200
POST
/v1/dataContracts/{id}/validate
Validate a data contract
validateDataContract 1 param → 200404
POST
/v1/dataContracts/entity/validate
Validate a data contract for an entity
validateDataContractByEntityId 2 params → 200404
POST
/v1/dataContracts/validate
Validate data contract request without creating
validateDataContractRequest body → 200400
POST
/v1/dataContracts/validate/yaml
Validate data contract request from YAML without creating
validateDataContractRequestYaml body → 200400
POST
/v1/dataContracts/odcs/validate/yaml
Validate ODCS YAML without importing
validateODCSYaml 3 params body → 200400

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are DataContract (48 properties), Policy (39 properties), ColumnProfile (30 properties), ODCSQualityRule (27 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ColumnProfile
object
30 properties 2 required
ODCSParseResult
object
5 properties
ODCSSupportChannel
object
6 properties 2 required
ODCSAuthoritativeDefinition
object
3 properties
TermsOfUse
object
2 properties
ContractSLA
object
7 properties
FailedRule
object
2 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
SemanticsValidation
object
4 properties
Retention
object
2 properties 2 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
CustomMetricProfile
object
2 properties
ODCSDataContract
object
23 properties 5 required
CardinalityDistribution
object
4 properties
ResultList
object
5 properties 1 required
ODCSSchemaElement
object
27 properties 1 required
Paging
object
5 properties 1 required
JsonPatch
object
QualityValidation
object
4 properties
ODCSDescription
object
3 properties
CustomMetric
object
8 properties 2 required
ODCSLogicalTypeOptions
object
16 properties
ChangeDescription
object
5 properties
ODCSQualityRule
object
27 properties
CustomProperties__3
object
ODCSServer
object
21 properties 2 required
SlaValidation
object
4 properties
DataContractResult
object
11 properties 3 required
SchemaValidation
object
6 properties
LatestResult
object
4 properties
UsageStats
object
2 properties 1 required
CustomProperties__2
object
RefreshFrequency
object
2 properties 2 required
DataContractList
object
5 properties 1 required
Style
object
3 properties
Column
object
18 properties 2 required
CustomProperties__1
object
Votes
object
4 properties
ContractValidation
object
4 properties
Histogram
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
ODCSRole
object
6 properties 1 required
CreateDataContract
object
22 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
ODCSTeamMember
object
7 properties
ContractUpdate
object
5 properties 3 required
ODCSCustomProperty
object
2 properties
Policy
object
39 properties 3 required
ODCSSlaProperty
object
6 properties 2 required
MaxLatency
object
2 properties 2 required
SemanticsRule
object
9 properties 4 required
DataContract
object
48 properties 3 required
CustomProperties
object
ContractSecurity
object
3 properties
EntityReference
object
9 properties 2 required
ODCSPricing
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-data-contracts-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
#Data Contracts
← Back to O APIs
API Details
ID
openmetadata:openmetadata-data-contracts-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-data-contracts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-data-contracts-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 Data Contracts 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.