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 Metadata API

These APIs are for managing custom property definitions in OpenMetadata. Use these APIs to create custom properties with predefined data types (String, Integer, Date, etc.) that extend entity metadata. Note: This does not support creating new custom data types - only custom properties using existing OpenMetadata data types.

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

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

This API exposes 17 operations across 11 paths, and defines 26 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 11 paths 26 schemas 3 DELETE9 GET2 PATCH1 POST2 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 Metadata 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 11 paths, the API surfaces 17 operations — 3 DELETE, 9 GET, 2 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata 17

These APIs are for managing custom property definitions in OpenMetadata. Use these APIs to create custom properties with predefined data types (String, Integer, Date, etc.) that e…

GET
/v1/metadata/types/{id}
Get a type
getTypeByID 4 params → 200404
PUT
/v1/metadata/types/{id}
Add or update a Property to an entity
addProperty 1 param body → 200404
DELETE
/v1/metadata/types/{id}
Delete a type by id
deleteType 1 param → 200404
PATCH
/v1/metadata/types/{id}
Update a type
patchType_1 1 param body → default
GET
/v1/metadata/types
List types
listTypes 4 params → 200
PUT
/v1/metadata/types
Create or update a type
createOrUpdate body → 200400
POST
/v1/metadata/types
Create a custom property definition
createType body → 200400
GET
/v1/metadata/types/name/{name}
Get a type by name
getTypeByName 3 params → 200404
DELETE
/v1/metadata/types/name/{name}
Delete a type by name
deleteTypeByName 1 param → 200404
DELETE
/v1/metadata/types/async/{id}
Asynchronously delete a type by id
deleteTypeAsync 1 param → 200404
GET
/v1/metadata/types/customProperties
getAllCustomPropertiesByEntityType → default
GET
/v1/metadata/types/name/{entityType}/customProperties
Get custom properties for an entity type
getCustomPropertiesByEntityType 2 params → 200404
GET
/v1/metadata/types/fields/{entityType}
getEntityTypeFields 2 params → default
GET
/v1/metadata/types/{id}/versions/{version}
Get a version of the types
getSpecificTypeVersion 2 params → 200404
GET
/v1/metadata/types/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_62 5 params → 200
GET
/v1/metadata/types/{id}/versions
List type versions
listAllTypeVersion 1 param → 200
PATCH
/v1/metadata/types/name/{fqn}
Update a type using name.
patchType 1 param body → default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Type (35 properties), TagLabel (13 properties), CreateType (13 properties), EntityReference (9 properties). Each schema is shown below with its type and property counts.

Type
object
35 properties 2 required
TagLabelRecognizerMetadata
object
5 properties 3 required
CustomPropertyConfig
object
1 property
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
TypeList
object
5 properties 1 required
CoverImage
object
2 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
CustomProperty
object
5 properties 3 required
UsageStats
object
2 properties 1 required
CreateType
object
13 properties 4 required
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-metadata-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 Metadata 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.