# Bytebase Plan Service API

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

Bytebase Plan 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 PlanService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

PlanService manages deployment plans for database changes.

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/projects/{project}/plans` | ListPlans |
| POST | `/v1/projects/{project}/plans` | CreatePlan |
| GET | `/v1/projects/{project}/plans/{plan}` | GetPlan |
| PATCH | `/v1/projects/{project}/plans/{plan}` | UpdatePlan |
| GET | `/v1/projects/{project}/plans/{plan}/planCheckRun` | GetPlanCheckRun |
| POST | `/v1/projects/{project}/plans/{plan}/planCheckRun:cancel` | CancelPlanCheckRun |
| POST | `/v1/projects/{project}/plans/{plan}:runPlanChecks` | RunPlanChecks |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bytebase/refs/heads/main/openapi/bytebase-planservice-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

PlanService

---

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