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 GitHub OpenAPI

Operations 21

PUT /v1/services/databaseServices/{id}/followers Add a follower #

PUT /v1/services/databaseServices/{id}/testConnectionResult Add test connection result #

GET /v1/services/databaseServices List database services #

PUT /v1/services/databaseServices Update database service #

POST /v1/services/databaseServices Create database service #

GET /v1/services/databaseServices/name/{name} Get database service by name #

DELETE /v1/services/databaseServices/name/{name} Delete a database service by name #

GET /v1/services/databaseServices/{id} Get a database service #

DELETE /v1/services/databaseServices/{id} Delete a database service by Id #

PATCH /v1/services/databaseServices/{id} Update a database service #

DELETE /v1/services/databaseServices/async/{id} Asynchronously delete a database service by Id #

DELETE /v1/services/databaseServices/{id}/followers/{userId} Remove a follower #

GET /v1/services/databaseServices/name/{name}/export Export database service in CSV format #

GET /v1/services/databaseServices/name/{name}/exportAsync Export database service in CSV format #

GET /v1/services/databaseServices/{id}/versions/{version} Get a version of the database service #

PUT /v1/services/databaseServices/name/{name}/import Import service from CSV to update database service (no creation allowed) #

PUT /v1/services/databaseServices/name/{name}/importAsync Import service from CSV to update database service asynchronously (no creation… #

GET /v1/services/databaseServices/history List all entity versions within a time range #

GET /v1/services/databaseServices/{id}/versions List database service versions #

PATCH /v1/services/databaseServices/name/{fqn} Update a database service using name #

PUT /v1/services/databaseServices/restore Restore a soft deleted database service #

Documentation

📖

Documentation

https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis

📖

Authentication

https://docs.open-metadata.org/latest/main-concepts/metadata-standard/apis

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-database-services-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/openmetadata-database-services-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: OpenMetadata Database Services API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.13'
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openmetadata/refs/heads/main/openapi/openmetadata-database-services-api-openapi.yml