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

A `Glossary` is collection of hierarchical `GlossaryTerms`.

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

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

This API exposes 53 operations across 42 paths, and defines 41 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.

53 operations 42 paths 41 schemas 7 DELETE24 GET4 PATCH4 POST14 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 Glossaries API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 53

Across 42 paths, the API surfaces 53 operations — 7 DELETE, 24 GET, 4 PATCH, 4 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Glossaries 53

A Glossary is collection of hierarchical GlossaryTerms.

GET
/v1/glossaries
List glossaries
listGlossaries 5 params → 200
PUT
/v1/glossaries
Create or update a glossary
createOrUpdateGlossary body → 200400
POST
/v1/glossaries
Create a glossary
createGlossary body → 200400
GET
/v1/glossaries/name/{name}
Get a glossary by name
getGlossaryByFQN 3 params → 200404
DELETE
/v1/glossaries/name/{name}
Delete a glossary by name
deleteGlossaryByName 3 params → 200404
GET
/v1/glossaries/{id}
Get a glossary by Id
getGlossaryByID 4 params → 200404
DELETE
/v1/glossaries/{id}
Delete a glossary by Id
deleteGlossary 3 params → 200404
PATCH
/v1/glossaries/{id}
Update a glossary
patchGlossary_1 1 param body → default
DELETE
/v1/glossaries/async/{id}
Asynchronously delete a glossary by Id
deleteGlossaryAsync 3 params → 200404
GET
/v1/glossaries/name/{name}/export
Export glossary in CSV format
exportGlossary 1 param → 200
GET
/v1/glossaries/name/{name}/exportAsync
Export glossary in CSV format
exportGlossary_1 1 param → 200
GET
/v1/glossaries/documentation/csv
Get CSV documentation
getCsvDocumentation → default
GET
/v1/glossaries/{id}/versions/{version}
Get a version of the glossaries
getSpecificGlossaryVersion 2 params → 200404
PUT
/v1/glossaries/name/{name}/import
Import glossary terms from CSV to create, and update glossary terms
importGlossary 2 params body → 200
PUT
/v1/glossaries/name/{name}/importAsync
Import glossary in CSV format asynchronously
importGlossaryAsync 2 params body → 200
GET
/v1/glossaries/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_29 5 params → 200
GET
/v1/glossaries/{id}/versions
List glossary versions
listAllGlossaryVersion 1 param → 200
PATCH
/v1/glossaries/name/{fqn}
Update a glossary using name.
patchGlossary 1 param body → default
PUT
/v1/glossaries/restore
Restore a soft deleted glossary
restore_21 body → 200
PUT
/v1/glossaries/{id}/vote
Update Vote for a Entity
updateVoteForEntity_9 1 param body → 200404
POST
/v1/glossaryTerms/{id}/relations
Add a typed relation to another glossary term
addTermRelation 1 param body → 200404
PUT
/v1/glossaryTerms/{id}/assets/add
Bulk Add Glossary Term to Assets
bulkAddGlossaryTermToAssets 1 param body → 200404
PUT
/v1/glossaryTerms/{id}/assets/remove
Bulk Remove Glossary Term from Assets
bulkRemoveGlossaryTermFromAssets 1 param body → 200404
GET
/v1/glossaryTerms
List glossary terms
listGlossaryTerm 9 params → 200
PUT
/v1/glossaryTerms
Create or update a glossary term
createOrUpdateGlossaryTerm body → 200400
POST
/v1/glossaryTerms
Create a glossary term
createGlossaryTerm body → 200400
POST
/v1/glossaryTerms/createMany
Create multiple glossary terms at once
createManyGlossaryTerm body → 200400
GET
/v1/glossaryTerms/name/{fqn}
Get a glossary term by fully qualified name
getGlossaryTermByFQN 4 params → 200404
DELETE
/v1/glossaryTerms/name/{fqn}
Delete a glossary term by fully qualified name
deleteGlossaryTermByName 3 params → 200404
PATCH
/v1/glossaryTerms/name/{fqn}
Update a glossary term by name.
patchGlossaryTerm 1 param body → default
GET
/v1/glossaryTerms/{id}
Get a glossary term by Id
getGlossaryTermByID 4 params → 200404
DELETE
/v1/glossaryTerms/{id}
Delete a glossary term by Id
delete 3 params → 200404
PATCH
/v1/glossaryTerms/{id}
Update a glossary term
patchGlossaryTerm_1 1 param body → default
DELETE
/v1/glossaryTerms/async/{id}
Asynchronously delete a glossary term by Id
deleteByIdAsync 3 params → 200404
GET
/v1/glossaryTerms/name/{fqn}/export
Export glossary term in CSV format
exportGlossaryTerm 1 param → 200
GET
/v1/glossaryTerms/name/{fqn}/exportAsync
Export glossary term in CSV format asynchronously
exportGlossaryTermAsync 1 param → 202
GET
/v1/glossaryTerms/assets/counts
Get all glossary terms with their asset counts
getAllGlossaryTermsWithAssetsCount 1 param → 200
GET
/v1/glossaryTerms/byIds
Get multiple glossary terms by Ids
getGlossaryTermsByIds 4 params → 200400
GET
/v1/glossaryTerms/relationTypes/usage
Get usage counts for all relation types
getRelationTypeUsageCounts → 200
GET
/v1/glossaryTerms/{id}/relationsGraph
Get the relation graph for a glossary term
getTermRelationGraph 3 params → 200404
GET
/v1/glossaryTerms/{id}/versions/{version}
Get a version of the glossary term
getSpecificGlossaryTermVersion 2 params → 200404
PUT
/v1/glossaryTerms/name/{fqn}/import
Import glossary terms from CSV
importGlossaryTerm 2 params body → 200
PUT
/v1/glossaryTerms/name/{fqn}/importAsync
Import glossary term from CSV asynchronously
importGlossaryTermAsync 2 params body → 200
GET
/v1/glossaryTerms/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_30 5 params → 200
GET
/v1/glossaryTerms/{id}/assets
List assets tagged with this glossary term
listGlossaryTermAssets 3 params → 200404
GET
/v1/glossaryTerms/name/{fqn}/assets
List assets tagged with this glossary term by fully qualified name
listGlossaryTermAssetsByName 3 params → 200404
GET
/v1/glossaryTerms/{id}/versions
List glossary term versions
listAllGlossaryTermVersion 1 param → 200
PUT
/v1/glossaryTerms/{id}/moveAsync
Move a glossary term to a new parent or glossary
moveGlossaryTerm 1 param body → 200
DELETE
/v1/glossaryTerms/{id}/relations/{toTermId}
Remove a relation to another glossary term
removeTermRelation 3 params → 200404
PUT
/v1/glossaryTerms/restore
Restore a soft deleted glossary term
restore_22 body → 200
GET
/v1/glossaryTerms/search
Search glossary terms with pagination
searchGlossaryTerms 10 params → 200
PUT
/v1/glossaryTerms/{id}/vote
Update Vote for a Entity
updateVoteForEntity_10 1 param body → 200404
PUT
/v1/glossaryTerms/{id}/tags/validate
Validate Tags Addition to Glossary Term
validateGlossaryTermTagsAddition 1 param body → 200404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are GlossaryTerm (41 properties), Glossary (35 properties), CreateGlossaryTerm (19 properties), ChangeEvent (14 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
BulkOperationResult
object
8 properties
ValidateGlossaryTagsRequest
object
2 properties
TermRelation
object
2 properties 1 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
CreateGlossary
object
12 properties 2 required
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
MoveGlossaryTermRequest
object
1 property
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
EntityHistory
object
2 properties 2 required
GlossaryList
object
5 properties 1 required
ResultList
object
5 properties 1 required
Glossary
object
35 properties 3 required
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
AddGlossaryToAssetsRequest
object
2 properties
TermReference
object
2 properties
CreateGlossaryTerm
object
19 properties 3 required
CSVExportResponse
object
2 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
CSVImportResponse
object
2 properties
Votes
object
4 properties
CsvImportResult
object
7 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
GlossaryTermList
object
5 properties 1 required
ConceptMapping
object
4 properties 2 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
GlossaryTerm
object
41 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-glossaries-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 Glossaries 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.