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 Database Schemas API

A `Database Schema` is collection of tables, views, stored procedures, and other database objects.

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

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

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

26 operations 18 paths 35 schemas 5 DELETE10 GET2 PATCH1 POST8 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 Database Schemas API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 26

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

Database Schemas 26

A Database Schema is collection of tables, views, stored procedures, and other database objects.

GET
/v1/databaseSchemas/{id}/databaseSchemaProfilerConfig
Get databaseSchema profile config
getDataProfilerConfig_1 1 param → 200
PUT
/v1/databaseSchemas/{id}/databaseSchemaProfilerConfig
Add databaseSchema profile config
addDataProfilerConfig_1 1 param body → 200
DELETE
/v1/databaseSchemas/{id}/databaseSchemaProfilerConfig
Delete database profiler config
delete DataProfilerConfig_1 1 param → 200
PUT
/v1/databaseSchemas/{id}/followers
Add a follower
addFollowerToDatabaseSchema 1 param body → 200404
PUT
/v1/databaseSchemas/bulk
Bulk create or update databaseSchemas
bulkCreateOrUpdateDatabaseSchemas 1 param body → 200202400
GET
/v1/databaseSchemas
List database schemas
listDBSchemas 9 params → 200
PUT
/v1/databaseSchemas
Create or update schema
createOrUpdateDBSchema body → 200
POST
/v1/databaseSchemas
Create a schema
createDBSchema body → 200400
GET
/v1/databaseSchemas/name/{fqn}
Get a schema by fully qualified name
getDBSchemaByFQN 4 params → 200404
DELETE
/v1/databaseSchemas/name/{fqn}
Delete a schema by fully qualified name
deleteDBSchemaByFQN 3 params → 200404
PATCH
/v1/databaseSchemas/name/{fqn}
Update a database schema by name.
patchDBSchema 1 param body → default
GET
/v1/databaseSchemas/{id}
Get a schema by Id
getDBSchemaByID 4 params → 200404
DELETE
/v1/databaseSchemas/{id}
Delete a schema by Id
deleteDBSchema 3 params → 200404
PATCH
/v1/databaseSchemas/{id}
Update a database schema
patchDBSchema_1 1 param body → default
DELETE
/v1/databaseSchemas/async/{id}
Asynchronously delete a schema by Id
deleteDBSchemaAsync 3 params → 200404
DELETE
/v1/databaseSchemas/{id}/followers/{userId}
Remove a follower
deleteFollower_7 2 params → 200
GET
/v1/databaseSchemas/name/{name}/export
Export database schema in CSV format
exportDatabaseSchema 2 params → 200
GET
/v1/databaseSchemas/name/{name}/exportAsync
Export database schema in CSV format
exportDatabaseSchema_1 2 params → 200
GET
/v1/databaseSchemas/{id}/versions/{version}
Get a version of the schema
getSpecificDBSchemaVersion 2 params → 200404
PUT
/v1/databaseSchemas/name/{name}/import
Import tables from CSV to update database schema (no creation allowed)
importDatabaseSchema 3 params body → 200
PUT
/v1/databaseSchemas/name/{name}/importAsync
Import tables from CSV to update database schema asynchronously (no creation allowed)
importDatabaseSchemaAsync 3 params body → 200
GET
/v1/databaseSchemas/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_14 5 params → 200
GET
/v1/databaseSchemas/{id}/versions
List schema versions
listAllDBSchemaVersion 1 param → 200
PUT
/v1/databaseSchemas/restore
Restore a soft deleted database schema.
restore_13 body → 200
GET
/v1/databaseSchemas/entityRelationship
Search Schema Entity Relationship
searchSchemaEntityRelationship 8 params → 200
PUT
/v1/databaseSchemas/{id}/vote
Update Vote for a Entity
updateVoteForEntity_3 1 param body → 200404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are DatabaseSchema (38 properties), CreateDatabaseSchema (14 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
BulkOperationResult
object
8 properties
DatabaseSchema
object
38 properties 4 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
ProfileSampleConfig
object
2 properties
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
VoteRequest
object
1 property
SearchResponse
object
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
CreateDatabaseSchema
object
14 properties 2 required
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
DatabaseSchemaProfilerConfig
object
4 properties
CSVExportResponse
object
2 properties
SampleDataStorageConfig
object
1 property
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
DatabaseSchemaList
object
5 properties 1 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-database-schemas-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 Database Schemas 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.