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

`Table` organizes data in rows and columns and is defined in a `Database Schema`.

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

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

This API exposes 51 operations across 38 paths, and defines 65 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.

51 operations 38 paths 65 schemas 11 DELETE22 GET2 PATCH1 POST15 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 Tables API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 51

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

Tables 51

Table organizes data in rows and columns and is defined in a Database Schema.

PUT
/v1/tables/{id}/customMetric
Add custom metrics
addCustomMetric 1 param body → 200
PUT
/v1/tables/{id}/dataModel
Add data modeling information to a table
addDataModel 1 param body → 200
PUT
/v1/tables/{id}/tableProfile
Add table profile data
addDataProfiler 1 param body → 200
GET
/v1/tables/{id}/tableProfilerConfig
Get table profile config
getDataProfilerConfig_2 1 param → 200
PUT
/v1/tables/{id}/tableProfilerConfig
Add table profile config
addDataProfilerConfig_2 1 param body → 200
DELETE
/v1/tables/{id}/tableProfilerConfig
Delete table profiler config
delete DataProfilerConfig_2 1 param → 200
PUT
/v1/tables/{id}/followers
Add a follower
addFollowerToTable 1 param body → 200404
PUT
/v1/tables/{id}/joins
Add table join information
addTableJoinInfo 1 param body → 200404400
GET
/v1/tables/{id}/pipelineObservability
Get pipeline observability data
getPipelineObservability 1 param → 200
PUT
/v1/tables/{id}/pipelineObservability
Add pipeline observability data
addPipelineObservability 1 param body → 200
DELETE
/v1/tables/{id}/pipelineObservability
Delete pipeline observability data
deletePipelineObservability 1 param → 200
GET
/v1/tables/{id}/sampleData
Get sample data
getSampleData 1 param → 200
PUT
/v1/tables/{id}/sampleData
Add sample data
addSampleData 1 param body → 200
DELETE
/v1/tables/{id}/sampleData
Delete sample data
deleteSampleData 1 param → 200
PUT
/v1/tables/{id}/pipelineObservability/{pipelineFqn}
Add or update single pipeline observability data
addSinglePipelineObservability 2 params body → 200
DELETE
/v1/tables/{id}/pipelineObservability/{pipelineFqn}
Delete single pipeline observability data
deleteSinglePipelineObservability 2 params → 200
PUT
/v1/tables/bulk
Bulk create or update tables
bulkCreateOrUpdateTables 1 param body → 200202400
GET
/v1/tables
List tables
listTables 12 params → 200
PUT
/v1/tables
Create or update a table
createOrUpdateTable body → 200400
POST
/v1/tables
Create a table
createTable body → 200400
GET
/v1/tables/{id}
Get a table by Id
getTableByID 4 params → 200404
DELETE
/v1/tables/{id}
Delete a table by Id
deleteTable 3 params → 200404
PATCH
/v1/tables/{id}
Update a table
patchTable_1 2 params body → default
GET
/v1/tables/name/{fqn}
Get a table by fully qualified name
getTableByFQN 4 params → 200404
DELETE
/v1/tables/name/{fqn}
Delete a table by fully qualified name
deleteTable_1 3 params → 200404
PATCH
/v1/tables/name/{fqn}
Update a table by name.
patchTable 2 params body → default
DELETE
/v1/tables/async/{id}
Asynchronously delete a table by Id
deleteTableAsync 3 params → 200404
DELETE
/v1/tables/{id}/customMetric/{columnName}/{customMetricName}
Delete custom metric from a column
deleteCustomMetric 3 params → 200
DELETE
/v1/tables/{fqn}/{entityType}/{timestamp}/profile
Delete table profile data
deleteDataProfiler 3 params → 200
DELETE
/v1/tables/{id}/followers/{userId}
Remove a follower
deleteFollower_9 2 params → 200
DELETE
/v1/tables/{id}/customMetric/{customMetricName}
Delete custom metric from a table
deleteCustomMetric_1 2 params → 200
GET
/v1/tables/name/{name}/export
Export table in CSV format
exportTable 1 param → 200
GET
/v1/tables/name/{name}/exportAsync
Export table in CSV format
exportTable_1 1 param → 200
GET
/v1/tables/{fqn}/tableProfile/latest
Get the latest table profile
Get the latest table and column profile 2 params → 200
GET
/v1/tables/name/{fqn}/pipelineObservability
Get pipeline observability data by table FQN
getPipelineObservabilityByFQN 1 param → 200
GET
/v1/tables/{id}/columns
Get table columns with pagination
getTableColumns 7 params → 200
GET
/v1/tables/name/{fqn}/columns
Get table columns with pagination by FQN
getTableColumnsByFQN 7 params → 200
GET
/v1/tables/{id}/versions/{version}
Get a version of the table
getSpecificDatabaseVersion_1 2 params → 200404
PUT
/v1/tables/name/{name}/import
Import columns from CSV to update table (no creation allowed)
importTable 2 params body → 200
PUT
/v1/tables/name/{name}/importAsync
Import columns from CSV to update table asynchronously (no creation allowed)
importTableAsync 2 params body → 200
GET
/v1/tables/{fqn}/columnProfile
List of column profiles
list column Profiles 3 params → 200
GET
/v1/tables/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_16 5 params → 200
GET
/v1/tables/{fqn}/systemProfile
List of system profiles
list system Profiles 3 params → 200
GET
/v1/tables/{fqn}/tableProfile
List of table profiles
list Profiles 3 params → 200
GET
/v1/tables/{id}/versions
List table versions
listAllTableVersion 1 param → 200
PUT
/v1/tables/restore
Restore a soft deleted table
restore_15 body → 200
GET
/v1/tables/entityRelationship
Search Entity Relationship
searchEntityRelationship 8 params → 200
GET
/v1/tables/entityRelationship/{direction}
Search entity relationship with Direction
searchEntityRelationshipWithDirection 9 params → 200
GET
/v1/tables/name/{fqn}/columns/search
Search table columns with pagination by FQN
searchTableColumnsByFQN 8 params → 200
GET
/v1/tables/{id}/columns/search
Search table columns with pagination by ID
searchTableColumnsById 8 params → 200
PUT
/v1/tables/{id}/vote
Update Vote for a Entity
updateVoteForEntity_5 1 param body → 200404

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are Table (58 properties), ColumnProfile (30 properties), CreateTable (23 properties), Column (18 properties). Each schema is shown below with its type and property counts.

CompressionStrategy
object
4 properties
Partitioning
object
3 properties 1 required
TagLabelRecognizerMetadata
object
5 properties 3 required
ColumnProfile
object
30 properties 2 required
BulkOperationResult
object
8 properties
SystemProfileList
object
5 properties 1 required
PartitionProfilerConfig
object
8 properties
TableList
object
5 properties 1 required
SparkTableProfilerConfig
object
1 property
ProfileSampleConfig
object
2 properties
AccessDetails
object
3 properties 1 required
ChangeSummaryMap
object
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
TableProfile
object
8 properties 1 required
CreateTableProfile
object
3 properties 1 required
LifeCycle
object
3 properties
DataModel
object
12 properties 1 required
JoinedWith
object
2 properties 2 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
CustomMetricProfile
object
2 properties
VoteRequest
object
1 property
CardinalityDistribution
object
4 properties
ResultList
object
5 properties 1 required
CreateCustomMetric
object
7 properties 2 required
SystemProfile
object
3 properties
TableData
object
2 properties
TableProfileList
object
5 properties 1 required
TableProfilerConfig
object
10 properties
ColumnProfilerConfig
object
2 properties
Paging
object
5 properties 1 required
LayerPaging
object
2 properties
RelationshipRef
object
4 properties
BulkResponse
object
3 properties
JsonPatch
object
CustomMetric
object
8 properties 2 required
PipelineObservability
object
8 properties 1 required
ChangeDescription
object
5 properties
SearchEntityRelationshipResult
object
3 properties
ColumnProfileList
object
5 properties 1 required
TablePartition
object
1 property
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
EsEntityRelationshipData
object
6 properties
TableJoins
object
4 properties
Style
object
3 properties
Column
object
18 properties 2 required
Votes
object
4 properties
CsvImportResult
object
7 properties
NodeInformation
object
3 properties
Histogram
object
2 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
Table
object
58 properties 3 required
TagLabelMetadata
object
2 properties
TableColumnList
object
5 properties 1 required
EntityError
object
2 properties
TableConstraint
object
4 properties
CreateTable
object
23 properties 3 required
EntityReference
object
9 properties 2 required
PartitionColumnDetails
object
3 properties
ColumnJoin
object
2 properties
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-tables-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 Tables 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.