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

A `Directory` is a folder or organizational unit in a Drive Service that can contain files, spreadsheets, and other directories.

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

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

This API exposes 21 operations across 15 paths, and defines 28 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.

21 operations 15 paths 28 schemas 4 DELETE7 GET2 PATCH2 POST6 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 Directories API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 15 paths, the API surfaces 21 operations — 4 DELETE, 7 GET, 2 PATCH, 2 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Directories 21

A Directory is a folder or organizational unit in a Drive Service that can contain files, spreadsheets, and other directories.

PUT
/v1/drives/directories/{id}/followers
Add a follower
addFollowerToDirectory 1 param body → 200404
PUT
/v1/drives/directories/bulk
Bulk create or update directories
bulkCreateOrUpdateDirectorys 1 param body → 200202400
GET
/v1/drives/directories
List directories
listDirectories 8 params → 200
PUT
/v1/drives/directories
Create or update a directory
createOrUpdateDirectory body → 200400
POST
/v1/drives/directories
Create a directory
createDirectory body → 200400
GET
/v1/drives/directories/name/{fqn}
Get a directory by fully qualified name
getDirectoryByFQN 4 params → 200404
DELETE
/v1/drives/directories/name/{fqn}
Delete a directory by fully qualified name
deleteDirectoryByFQN 3 params → 200404
PATCH
/v1/drives/directories/name/{fqn}
Update a directory by name.
patchDirectory 1 param body → default
GET
/v1/drives/directories/{id}
Get a directory by Id
getDirectoryByID 4 params → 200404
DELETE
/v1/drives/directories/{id}
Delete a directory by Id
deleteDirectory 3 params → 200404
PATCH
/v1/drives/directories/{id}
Update a directory
patchDirectory_1 1 param body → default
DELETE
/v1/drives/directories/async/{id}
Asynchronously delete a directory by Id
deleteDirectoryAsync 3 params → 200404
DELETE
/v1/drives/directories/{id}/followers/{userId}
Remove a follower
removeFollowerFromDirectory 2 params → 200
GET
/v1/drives/directories/export
Export directories to CSV
exportDirectories 1 param → 200
GET
/v1/drives/directories/{id}/versions/{version}
Get a specific version of the directory
getSpecificDirectoryVersion 2 params → 200404
POST
/v1/drives/directories/import
Import directory from CSV
importDirectory 1 param body → 200
GET
/v1/drives/directories/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_24 5 params → 200
GET
/v1/drives/directories/{id}/versions
List directory versions
listAllDirectoryVersion 1 param → 200
PUT
/v1/drives/directories/restore
Restore a soft deleted directory by id
restoreDirectoryById body → 200
PUT
/v1/drives/directories/{id}/restore
Restore a soft deleted directory
restoreDirectory 1 param → 200
PUT
/v1/drives/directories/{id}/vote
Update Vote for a directory
updateVoteForDirectory 1 param body → 200404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Directory (41 properties), CreateDirectory (20 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
Directory
object
41 properties 3 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
JsonPatch
object
CreateDirectory
object
20 properties 2 required
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 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
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
DirectoryList
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-directories-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 Directories 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.