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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenMetadata

OpenMetadata Database Services API

`Database Service` is a service such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenMetadata Database Services 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 Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 21 operations across 16 paths, and defines 31 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 16 paths 31 schemas 4 DELETE8 GET2 PATCH1 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
Contact
OpenMetadata
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

OpenMetadata Database Services 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 16 paths, the API surfaces 21 operations — 4 DELETE, 8 GET, 2 PATCH, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Database Services 21

Database Service is a service such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for dat…

PUT
/v1/services/databaseServices/{id}/followers
Add a follower
addFollowerToDatabaseService 1 param body → 200404
PUT
/v1/services/databaseServices/{id}/testConnectionResult
Add test connection result
addTestConnectionResult_2 1 param body → 200
GET
/v1/services/databaseServices
List database services
listDatabaseServices 6 params → 200
PUT
/v1/services/databaseServices
Update database service
createOrUpdateDatabaseService body → 200400
POST
/v1/services/databaseServices
Create database service
createDatabaseService body → 200400
GET
/v1/services/databaseServices/name/{name}
Get database service by name
getDatabaseServiceByFQN 4 params → 200404
DELETE
/v1/services/databaseServices/name/{name}
Delete a database service by name
deleteDatabaseServiceByName 3 params → 200404
GET
/v1/services/databaseServices/{id}
Get a database service
getDatabaseServiceByID 4 params → 200404
DELETE
/v1/services/databaseServices/{id}
Delete a database service by Id
deleteDatabaseService 3 params → 200404
PATCH
/v1/services/databaseServices/{id}
Update a database service
patchDatabaseService_1 1 param body → default
DELETE
/v1/services/databaseServices/async/{id}
Asynchronously delete a database service by Id
deleteDatabaseServiceAsync 3 params → 200404
DELETE
/v1/services/databaseServices/{id}/followers/{userId}
Remove a follower
deleteFollower_17 2 params → 200
GET
/v1/services/databaseServices/name/{name}/export
Export database service in CSV format
exportDatabaseServices 2 params → 200
GET
/v1/services/databaseServices/name/{name}/exportAsync
Export database service in CSV format
exportDatabaseService 2 params → 200
GET
/v1/services/databaseServices/{id}/versions/{version}
Get a version of the database service
getSpecificDatabaseServiceVersion 2 params → 200404
PUT
/v1/services/databaseServices/name/{name}/import
Import service from CSV to update database service (no creation allowed)
importDatabaseService 3 params body → 200
PUT
/v1/services/databaseServices/name/{name}/importAsync
Import service from CSV to update database service asynchronously (no creation allowed)
importDatabaseServiceAsync 3 params body → 200
GET
/v1/services/databaseServices/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_42 5 params → 200
GET
/v1/services/databaseServices/{id}/versions
List database service versions
listAllDatabaseServiceVersion 1 param → 200
PATCH
/v1/services/databaseServices/name/{fqn}
Update a database service using name.
patchDatabaseService 1 param body → default
PUT
/v1/services/databaseServices/restore
Restore a soft deleted database service
restore_32 body → 200

Schemas 31

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

TagLabelRecognizerMetadata
object
5 properties 3 required
DatabaseService
object
36 properties 3 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
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
CSVExportResponse
object
2 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
DatabaseConnection
object
1 property
CsvImportResult
object
7 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
CreateDatabaseService
object
13 properties 2 required
DatabaseServiceList
object
5 properties 1 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
TestConnectionStepResult
object
5 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-database-services-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
AE Profile APIs.io
OpenMetadata AI Applications API
AE Profile APIs.io
OpenMetadata AI Governance Policies API
AE Profile APIs.io
OpenMetadata API Collections API
AE Profile APIs.io
OpenMetadata API Endpoint API
AE Profile APIs.io
OpenMetadata API Services API
AE Profile APIs.io
OpenMetadata Apps API
AE Profile APIs.io
OpenMetadata Audit Logs API
AE Profile APIs.io
OpenMetadata Bots API
AE Profile APIs.io
OpenMetadata ChangeSummary API
AE Profile APIs.io
OpenMetadata Charts API
AE Profile APIs.io
OpenMetadata Classifications API
AE Profile APIs.io
#Database Services
← Back to O APIs
API Details
ID
openmetadata:openmetadata-database-services-api
Base URL
https://{your-host}/api/v1
Docs
https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis
Provider
OpenMetadata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openmetadata-database-services-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openmetadata-database-services-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenMetadata Database Services 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.