# Bytebase Instance Service API

**Canonical:** https://apis.io/apis/bytebase/bytebase-instanceservice-api/  
**Provider:** Bytebase — https://apis.io/providers/bytebase/  
**Base URL:** https://demo.bytebase.com/v1  
**Documentation:** https://docs.bytebase.com/integrations/api/overview

Bytebase Instance Service API is one of 33 APIs that [Bytebase](https://apis.io/providers/bytebase/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include InstanceService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

InstanceService manages database instances and their connections.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/openapi/bytebase-instanceservice-api-openapi.yml
- **Documentation** — https://docs.bytebase.com/integrations/api/overview
- **APIReference** — https://api.bytebase.com/
- **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

## Other Bytebase APIs (12)

- [Bytebase Access Grant Service API](https://apis.io/apis/bytebase/bytebase-accessgrantservice-api/)
- [Bytebase Actuator Service API](https://apis.io/apis/bytebase/bytebase-actuatorservice-api/)
- [Bytebase AI Service API](https://apis.io/apis/bytebase/bytebase-aiservice-api/)
- [Bytebase Audit Log Service API](https://apis.io/apis/bytebase/bytebase-auditlogservice-api/)
- [Bytebase Cel Service API](https://apis.io/apis/bytebase/bytebase-celservice-api/)
- [Bytebase Changelog Service API](https://apis.io/apis/bytebase/bytebase-changelogservice-api/)
- [Bytebase Database Catalog Service API](https://apis.io/apis/bytebase/bytebase-databasecatalogservice-api/)
- [Bytebase Database Group Service API](https://apis.io/apis/bytebase/bytebase-databasegroupservice-api/)
- [Bytebase Database Service API](https://apis.io/apis/bytebase/bytebase-databaseservice-api/)
- [Bytebase Group Service API](https://apis.io/apis/bytebase/bytebase-groupservice-api/)
- [Bytebase Identity Provider Service API](https://apis.io/apis/bytebase/bytebase-identityproviderservice-api/)
- [Bytebase Instance Role Service API](https://apis.io/apis/bytebase/bytebase-instanceroleservice-api/)

## Tags

InstanceService

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bytebase/bytebase-instanceservice-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bytebase/.