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

A `File` is a document or resource stored in a Drive Service.

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

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

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

22 operations 14 paths 34 schemas 5 DELETE7 GET2 PATCH1 POST7 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 Files API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 22

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

Files 22

A File is a document or resource stored in a Drive Service.

PUT
/v1/drives/files/{id}/followers
Add a follower
addFollowerToFile 1 param body → 200404
GET
/v1/drives/files/{id}/sampleData
Get sample data
getSampleData_1 1 param → 200
PUT
/v1/drives/files/{id}/sampleData
Add sample data
addSampleData_1 1 param body → 200
DELETE
/v1/drives/files/{id}/sampleData
Delete sample data
deleteSampleData_1 1 param → 200
PUT
/v1/drives/files/bulk
Bulk create or update files
bulkCreateOrUpdateFiles 1 param body → 200202400
GET
/v1/drives/files
List files
listFiles 9 params → 200
PUT
/v1/drives/files
Create or update a file
createOrUpdateFile body → 200400
POST
/v1/drives/files
Create a file
createFile body → 200400
GET
/v1/drives/files/name/{fqn}
Get a file by fully qualified name
getFileByFQN 4 params → 200404
DELETE
/v1/drives/files/name/{fqn}
Delete a file by fully qualified name
deleteFileByFQN 2 params → 200404
PATCH
/v1/drives/files/name/{fqn}
Update a file by name.
patchFile 1 param body → default
GET
/v1/drives/files/{id}
Get a file by Id
getFileByID 4 params → 200404
DELETE
/v1/drives/files/{id}
Delete a file by Id
deleteFile 2 params → 200404
PATCH
/v1/drives/files/{id}
Update a file
patchFile_1 1 param body → default
DELETE
/v1/drives/files/async/{id}
Asynchronously delete a file by Id
deleteFileAsync 3 params → 200404
DELETE
/v1/drives/files/{id}/followers/{userId}
Remove a follower
removeFollowerFromFile 2 params → 200
GET
/v1/drives/files/{id}/versions/{version}
Get a specific version of the file
getSpecificFileVersion 2 params → 200404
GET
/v1/drives/files/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_25 5 params → 200
GET
/v1/drives/files/{id}/versions
List file versions
listAllFileVersion 1 param → 200
PUT
/v1/drives/files/restore
Restore a soft deleted file by id
restoreFileById body → 200
PUT
/v1/drives/files/{id}/restore
Restore a soft deleted file
restoreFile 1 param → 200
PUT
/v1/drives/files/{id}/vote
Update Vote for a file
updateVoteForFile 1 param body → 200404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are File (50 properties), ColumnProfile (30 properties), CreateFile (25 properties), Column (18 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
FileList
object
5 properties 1 required
ColumnProfile
object
30 properties 2 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
RestoreEntity
object
1 property 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
CustomMetricProfile
object
2 properties
CreateFile
object
25 properties 2 required
CardinalityDistribution
object
4 properties
ResultList
object
5 properties 1 required
VoteRequest
object
1 property
TableData
object
2 properties
Paging
object
5 properties 1 required
JsonPatch
object
CustomMetric
object
8 properties 2 required
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
File
object
50 properties 3 required
UsageStats
object
2 properties 1 required
Column
object
18 properties 2 required
Style
object
3 properties
Votes
object
4 properties
Histogram
object
2 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-files-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 Files 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.