Bytebase

Bytebase Instance Service API

InstanceService manages database instances and their connections.

GitHub OpenAPI

Operations 27

GET /v1/instances ListInstances #
POST /v1/instances CreateInstance #
GET /v1/instances/{instance} GetInstance #
DELETE /v1/instances/{instance} DeleteInstance #
PATCH /v1/instances/{instance} UpdateInstance #
POST /v1/instances/{instance}:addDataSource AddDataSource #
POST /v1/instances/{instance}:databases ListInstanceDatabase #
POST /v1/instances/{instance}:removeDataSource RemoveDataSource #
POST /v1/instances/{instance}:sync SyncInstance #
POST /v1/instances/{instance}:undelete UndeleteInstance #
PATCH /v1/instances/{instance}:updateDataSource UpdateDataSource #
POST /v1/instances:batchSync BatchSyncInstances #
POST /v1/instances:batchUpdate BatchUpdateInstances #
GET /v1/projects/{project}/instances ListInstances #
POST /v1/projects/{project}/instances CreateInstance #
GET /v1/projects/{project}/instances/{instance} GetInstance #
DELETE /v1/projects/{project}/instances/{instance} DeleteInstance #
PATCH /v1/projects/{project}/instances/{instance} UpdateInstance #
POST /v1/projects/{project}/instances/{instance}:addDataSource AddDataSource #
POST /v1/projects/{project}/instances/{instance}:databases ListInstanceDatabase #
POST /v1/projects/{project}/instances/{instance}:removeDataSource RemoveDataSource #
POST /v1/projects/{project}/instances/{instance}:sync SyncInstance #
POST /v1/projects/{project}/instances/{instance}:undelete UndeleteInstance #
PATCH /v1/projects/{project}/instances/{instance}:updateDataSource UpdateDataSource #
POST /v1/projects/{project}/instances:batchSync BatchSyncInstances #
POST /v1/projects/{project}/instances:batchUpdate BatchUpdateInstances #
POST /v1/projects/{project}/instances:prepareSampleProjectInstance PrepareSampleProjectInstance #

Documentation

📖
Documentation
https://docs.bytebase.com/integrations/api/overview
📖
APIReference
https://api.bytebase.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/openapi/bytebase-instanceservice-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/collections/bytebase.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/collections/bytebase.opencollection.json

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/bytebase:bytebase-instanceservice-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

bytebase-instanceservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bytebase API Reference Instance Service API
  description: API reference for Bytebase. Every endpoint is served by your own Bytebase instance.
  version: 1.0.0
security: []
tags:


# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/openapi/bytebase-instanceservice-api-openapi.yml