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

A `Spreadsheet` is a file format for organizing data in a tabular format, like Google Sheets or Excel files.

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

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

This API exposes 18 operations across 12 paths, and defines 27 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.

18 operations 12 paths 27 schemas 4 DELETE6 GET2 PATCH1 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
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Spreadsheets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 18

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

Spreadsheets 18

A Spreadsheet is a file format for organizing data in a tabular format, like Google Sheets or Excel files.

PUT
/v1/drives/spreadsheets/{id}/followers
Add a follower
addFollowerToSpreadsheet 1 param body → 200404
PUT
/v1/drives/spreadsheets/bulk
Bulk create or update spreadsheets
bulkCreateOrUpdateSpreadsheets 1 param body → 200202400
GET
/v1/drives/spreadsheets
List spreadsheets
listSpreadsheets 8 params → 200
PUT
/v1/drives/spreadsheets
Create or update a spreadsheet
createOrUpdateSpreadsheet body → 200400
POST
/v1/drives/spreadsheets
Create a spreadsheet
createSpreadsheet body → 200400
GET
/v1/drives/spreadsheets/name/{fqn}
Get a spreadsheet by fully qualified name
getSpreadsheetByFQN 4 params → 200404
DELETE
/v1/drives/spreadsheets/name/{fqn}
Delete a spreadsheet by fully qualified name
deleteSpreadsheetByFQN 3 params → 200404
PATCH
/v1/drives/spreadsheets/name/{fqn}
Update a spreadsheet by name.
patchSpreadsheet 1 param body → default
GET
/v1/drives/spreadsheets/{id}
Get a spreadsheet by Id
getSpreadsheetByID 4 params → 200404
DELETE
/v1/drives/spreadsheets/{id}
Delete a spreadsheet by Id
deleteSpreadsheet 3 params → 200404
PATCH
/v1/drives/spreadsheets/{id}
Update a spreadsheet
patchSpreadsheet_1 1 param body → default
DELETE
/v1/drives/spreadsheets/async/{id}
Asynchronously delete a spreadsheet by Id
deleteSpreadsheetAsync 3 params → 200404
DELETE
/v1/drives/spreadsheets/{id}/followers/{userId}
Remove a follower
removeFollowerFromSpreadsheet 2 params → 200
GET
/v1/drives/spreadsheets/{id}/versions/{version}
Get a specific version of the spreadsheet
getSpecificSpreadsheetVersion 2 params → 200404
GET
/v1/drives/spreadsheets/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_26 5 params → 200
GET
/v1/drives/spreadsheets/{id}/versions
List spreadsheet versions
listAllSpreadsheetVersion 1 param → 200
PUT
/v1/drives/spreadsheets/restore
Restore a soft deleted spreadsheet
restoreSpreadsheet body → 200
PUT
/v1/drives/spreadsheets/{id}/vote
Update Vote for a spreadsheet
updateVoteForSpreadsheet 1 param body → 200404

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Spreadsheet (44 properties), CreateSpreadsheet (21 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
RestoreEntity
object
1 property 1 required
CoverImage
object
2 properties
FieldChange
object
3 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
CreateSpreadsheet
object
21 properties 2 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
SpreadsheetList
object
5 properties 1 required
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 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
Spreadsheet
object
44 properties 3 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-spreadsheets-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 Spreadsheets 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.