bytebase — API

Bytebase API Referencev1.0.0 Read the vendor's spec ↗

279 endpoints
3 deprecated
3 versions archived since Sep 23, 2026
Last checked Oct 17, 2026

API reference for Bytebase.

first call

$ curl "$BASE_URL/v1/users/me"

Set $BASE_URL first, then paste.

Base URL: Not named in the archived spec. $BASE_URL below stands for the origin you deploy against.
Authenticate: No authentication declared in the spec
Shape: GET103
POST128
PATCH29
DELETE19

What it covers

Databaseservice 31 DatabaseService manages databases and their schemas.
Instanceservice 27 InstanceService manages database instances and their connections.
Userservice 16 UserService manages user accounts and authentication.
Issueservice 15 IssueService manages issues for tracking database changes and tasks.
Orgpolicyservice 15 OrgPolicyService manages organizational policies at various resource levels.
Projectservice 15 ProjectService manages projects that group databases and changes.
Authservice 11 AuthService handles user authentication operations.
Rolloutservice 11 RolloutService manages the execution of deployment plans.
Savedqueryservice 11 SavedQueryService manages saved queries in the SQL Editor.
Subscriptionservice 10 SubscriptionService manages enterprise subscriptions and licensing.
Releaseservice 8 ReleaseService manages releases for coordinating deployments.
Revisionservice 8 RevisionService manages schema revision history.

21 more areas

Sqlservice 8 SQLService executes SQL queries and manages query operations.
Serviceaccountservice 8 ServiceAccountService manages service accounts for API integrations.
Workloadidentityservice 8 WorkloadIdentityService manages workload identities for external CI/CD integrations.
Workspaceservice 8 WorkspaceService manages workspace-level operations and profile.
Identityproviderservice 7 IdentityProviderService manages external identity providers for SSO authentication.
Planservice 7 PlanService manages deployment plans for database changes.
Accessgrantservice 6 AccessGrantService manages temporary access grants within projects.
Groupservice 6 GroupService manages user groups for organizing users and permissions.
Databasegroupservice 5 DatabaseGroupService manages database groups for organizing databases by criteria.
Reviewconfigservice 5 ReviewConfigService manages approval flow configurations.
Roleservice 5 RoleService manages workspace roles and permissions.
Auditlogservice 4 AuditLogService manages audit logs for system activities and API calls.
Changelogservice 4 ChangelogService manages database migration history.
Databasecatalogservice 4 DatabaseCatalogService manages database schema metadata and classification.
Settingservice 4 SettingService manages workspace-level settings and configurations.
Queryhistoryservice 3 QueryHistoryService manages query history records of SQL Editor queries and exports.
Sheetservice 3 SheetService manages SQL scripts and saved queries.
Celservice 2 CelService manages CEL (Common Expression Language) parsing and formatting operations.
Instanceroleservice 2 InstanceRoleService manages database roles within instances.
Aiservice 1 AIService provides AI chat capabilities for the page agent.
Actuatorservice 1 ActuatorService manages system health and operational information.

Open an endpoint for a runnable command, its inputs and what it returns.

Databaseservice 31

Instanceservice 27

DELETE /v1/instances/{instance} DeleteInstance

Loading…
DELETE /v1/projects/{project}/instances/{instance} DeleteInstance

Loading…
GET /v1/instances ListInstances

Loading…
GET /v1/instances/{instance} GetInstance

Loading…
GET /v1/projects/{project}/instances ListInstances

Loading…
GET /v1/projects/{project}/instances/{instance} GetInstance

Loading…
PATCH /v1/instances/{instance} UpdateInstance

Loading…
PATCH /v1/instances/{instance}:updateDataSource UpdateDataSource

Loading…
PATCH /v1/projects/{project}/instances/{instance} UpdateInstance

Loading…
PATCH /v1/projects/{project}/instances/{instance}:updateDataSource UpdateDataSource

Loading…
POST /v1/instances CreateInstance

Loading…
POST /v1/instances/{instance}:addDataSource AddDataSource

Loading…
POST /v1/instances/{instance}:databases ListInstanceDatabase

Loading…
POST /v1/instances/{instance}:removeDataSource RemoveDataSource

Loading…
POST /v1/instances/{instance}:sync SyncInstance

Loading…
POST /v1/instances/{instance}:undelete UndeleteInstance

Loading…
POST /v1/instances:batchSync BatchSyncInstances

Loading…
POST /v1/instances:batchUpdate BatchUpdateInstances

Loading…
POST /v1/projects/{project}/instances CreateInstance

Loading…
POST /v1/projects/{project}/instances/{instance}:addDataSource AddDataSource

Loading…
POST /v1/projects/{project}/instances/{instance}:databases ListInstanceDatabase

Loading…
POST /v1/projects/{project}/instances/{instance}:removeDataSource RemoveDataSource

Loading…
POST /v1/projects/{project}/instances/{instance}:sync SyncInstance

Loading…
POST /v1/projects/{project}/instances/{instance}:undelete UndeleteInstance

Loading…
POST /v1/projects/{project}/instances:batchSync BatchSyncInstances

Loading…
POST /v1/projects/{project}/instances:batchUpdate BatchUpdateInstances

Loading…
POST /v1/projects/{project}/instances:prepareSampleProjectInstance PrepareSampleProjectInstance

Loading…

Userservice 16

DELETE /v1/users/{user} DeleteUser

Loading…
GET /v1/users ListUsers

Loading…
GET /v1/users/me GetCurrentUser

Loading…
GET /v1/users/{user} GetUser

Loading…
GET /v1/users:batchGet BatchGetUsers

Loading…
PATCH /v1/users/{user} UpdateUser

Loading…
POST /v1/users CreateUser

Loading…
POST /v1/users/{user}:changePassword ChangePassword

Loading…
POST /v1/users/{user}:confirmRecoveryCodes ConfirmRecoveryCodes

Loading…
POST /v1/users/{user}:disableMFA DisableMFA

Loading…
POST /v1/users/{user}:enableMFA EnableMFA

Loading…
POST /v1/users/{user}:regenerateRecoveryCodes RegenerateRecoveryCodes

Loading…
POST /v1/users/{user}:requestReauthCode RequestReauthCode

Loading…
POST /v1/users/{user}:startMFAEnrollment StartMFAEnrollment

Loading…
POST /v1/users/{user}:undelete UndeleteUser

Loading…
POST /v1/users/{user}:updateEmail UpdateEmail

Loading…

Issueservice 15

GET /v1/projects/{project}/issues ListIssues

Loading…
GET /v1/projects/{project}/issues/{issue} GetIssue

Loading…
GET /v1/projects/{project}/issues/{issue}/issueComments ListIssueComments

Loading…
GET /v1/projects/{project}/issues/{issue}/reviewRuns/{reviewRun} GetReviewRun

Loading…
PATCH /v1/projects/{project}/issues/{issue} UpdateIssue

Loading…
PATCH /v1/projects/{project}/issues/{issue}:comment UpdateIssueComment

Loading…
POST /v1/projects/{project}/issues CreateIssue

Loading…
POST /v1/projects/{project}/issues/{issue}/reviewRuns/{reviewRun}:run RunReview

Loading…
POST /v1/projects/{project}/issues/{issue}:approve ApproveIssue

Loading…
POST /v1/projects/{project}/issues/{issue}:comment CreateIssueComment

Loading…
POST /v1/projects/{project}/issues/{issue}:reject RejectIssue

Loading…
POST /v1/projects/{project}/issues/{issue}:request RequestIssue

Loading…
POST /v1/projects/{project}/issues/{issue}:retryApproval RetryIssueApproval

Loading…
POST /v1/projects/{project}/issues:batchUpdateStatus BatchUpdateIssuesStatus

Loading…
POST /v1/projects/{project}/issues:search SearchIssues

Loading…

Orgpolicyservice 15

DELETE /v1/environments/{environment}/policies/{policy} DeletePolicy

Loading…
DELETE /v1/projects/{project}/policies/{policy} DeletePolicy

Loading…
DELETE /v1/workspaces/{workspace}/policies/{policy} DeletePolicy

Loading…
GET /v1/environments/{environment}/policies ListPolicies

Loading…
GET /v1/environments/{environment}/policies/{policy} GetPolicy

Loading…
GET /v1/projects/{project}/policies ListPolicies

Loading…
GET /v1/projects/{project}/policies/{policy} GetPolicy

Loading…
GET /v1/workspaces/{workspace}/policies ListPolicies

Loading…
GET /v1/workspaces/{workspace}/policies/{policy} GetPolicy

Loading…
PATCH /v1/environments/{environment}/policies/{policy} UpdatePolicy

Loading…
PATCH /v1/projects/{project}/policies/{policy} UpdatePolicy

Loading…
PATCH /v1/workspaces/{workspace}/policies/{policy} UpdatePolicy

Loading…
POST /v1/environments/{environment}/policies CreatePolicy

Loading…
POST /v1/projects/{project}/policies CreatePolicy

Loading…
POST /v1/workspaces/{workspace}/policies CreatePolicy

Loading…

Projectservice 15

DELETE /v1/projects/{project} DeleteProject

Loading…
GET /v1/projects ListProjects

Loading…
GET /v1/projects/{project} GetProject

Loading…
GET /v1/projects/{project}:getIamPolicy GetIamPolicy

Loading…
GET /v1/projects:batchGet BatchGetProjects

Loading…
PATCH /v1/projects/{project} UpdateProject

Loading…
PATCH /v1/projects/{project}/webhooks/{webhook}:updateWebhook UpdateWebhook

Loading…
POST /v1/projects CreateProject

Loading…
POST /v1/projects/{project}/webhooks/{webhook}:removeWebhook RemoveWebhook

Loading…
POST /v1/projects/{project}:addWebhook AddWebhook

Loading…
POST /v1/projects/{project}:setIamPolicy SetIamPolicy

Loading…
POST /v1/projects/{project}:testWebhook TestWebhook

Loading…
POST /v1/projects/{project}:undelete UndeleteProject

Loading…
POST /v1/projects:batchDelete BatchDeleteProjects

Loading…
POST /v1/projects:search SearchProjects

Loading…

Authservice 11

GET /v1/auth/info GetAuthenticationInfo

Loading…
GET /v1/workspaces/{workspace}/auth/info GetAuthenticationInfo

Loading…
POST /v1/auth/login Login

Loading…
POST /v1/auth/logout Logout

Loading…
POST /v1/auth/refresh Refresh

Loading…
POST /v1/auth/signup Signup

Loading…
POST /v1/auth:exchangeToken ExchangeToken

Loading…
POST /v1/auth:requestPasswordReset RequestPasswordReset

Loading…
POST /v1/auth:resetPassword ResetPassword

Loading…
POST /v1/auth:sendEmailLoginCode SendEmailLoginCode

Loading…
POST /v1/auth:switchWorkspace SwitchWorkspace

Loading…

Rolloutservice 11

GET /v1/projects/{project}/plans/{plan}/rollout GetRollout

Loading…
GET /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns ListTaskRuns

Loading…
GET /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun} GetTaskRun

Loading…
GET /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/log GetTaskRunLog

Loading…
GET /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}/session GetTaskRunSession

Loading…
GET /v1/projects/{project}/rollouts ListRollouts

Loading…
POST /v1/projects/{project}/plans/{plan}/rollout CreateRollout

Loading…
POST /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns/{taskRun}:previewRollback PreviewTaskRunRollback

Loading…
POST /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}/taskRuns:batchCancel BatchCancelTaskRuns

Loading…
POST /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks:batchRun BatchRunTasks

Loading…
POST /v1/projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks:batchSkip BatchSkipTasks

Loading…

Savedqueryservice 11

DELETE /v1/projects/{project}/savedQueries/{savedQuery} DeleteSavedQuery

Loading…
GET /v1/projects/{project}/savedQueries ListSavedQueries

Loading…
GET /v1/projects/{project}/savedQueries/{savedQuery} GetSavedQuery

Loading…
GET /v1/projects/{project}/savedQueries/{savedQuery}:getPolicy GetSavedQueryPolicy

Loading…
PATCH /v1/projects/{project}/savedQueries/{savedQuery} UpdateSavedQuery

Loading…
POST /v1/projects/{project}/savedQueries CreateSavedQuery

Loading…
POST /v1/projects/{project}/savedQueries/{savedQuery}:setPolicy SetSavedQueryPolicy

Loading…
POST /v1/projects/{project}/savedQueries/{savedQuery}:updateStar UpdateSavedQueryStar

Loading…
POST /v1/projects/{project}/savedQueries:moveMy MoveMySavedQueries

Loading…
POST /v1/projects/{project}/savedQueries:search SearchSavedQueries

Loading…
POST /v1/projects/{project}/savedQueries:searchFolders SearchSavedQueryFolders

Loading…

Subscriptionservice 10

GET /v1/subscription GetSubscription

Loading…
GET /v1/subscription/checkoutSession/{sessionId} VerifyCheckoutSession

Loading…
GET /v1/subscription/paymentInfo GetPaymentInfo

Loading…
GET /v1/subscription/plans ListPurchasePlans

Loading…
GET /v1/subscription:vcsProviderUsersExport ExportVCSProviderUsers

Loading…
PATCH /v1/subscription/license UploadLicense

Loading…
POST /v1/subscription:cancelPurchase CancelPurchase

Loading…
POST /v1/subscription:purchase CreatePurchase

Loading…
POST /v1/subscription:startTrial StartTrial

Loading…
POST /v1/subscription:updatePurchase UpdatePurchase

Loading…

Releaseservice 8

DELETE /v1/projects/{project}/releases/{release} DeleteRelease

Loading…
GET /v1/projects/{project}/releases ListReleases

Loading…
GET /v1/projects/{project}/releases/{release} GetRelease

Loading…
GET /v1/projects/{project}/releases:listCategories ListReleaseCategories

Loading…
PATCH /v1/projects/{project}/releases/{release} UpdateRelease

Loading…
POST /v1/projects/{project}/releases CreateRelease

Loading…
POST /v1/projects/{project}/releases/{release}:undelete UndeleteRelease

Loading…
POST /v1/projects/{project}/releases:check CheckRelease

Loading…

Revisionservice 8

DELETE /v1/instances/{instance}/databases/{database}/revisions/{revision} DeleteRevision

Loading…
DELETE /v1/projects/{project}/instances/{instance}/databases/{database}/revisions/{revision} DeleteRevision

Loading…
GET /v1/instances/{instance}/databases/{database}/revisions ListRevisions

Loading…
GET /v1/instances/{instance}/databases/{database}/revisions/{revision} GetRevision

Loading…
GET /v1/projects/{project}/instances/{instance}/databases/{database}/revisions ListRevisions

Loading…
GET /v1/projects/{project}/instances/{instance}/databases/{database}/revisions/{revision} GetRevision

Loading…
POST /v1/instances/{instance}/databases/{database}/revisions:batchCreate BatchCreateRevisions

Loading…
POST /v1/projects/{project}/instances/{instance}/databases/{database}/revisions:batchCreate BatchCreateRevisions

Loading…

Serviceaccountservice 8

DELETE /v1/serviceAccounts/{serviceAccount} DeleteServiceAccount

Loading…
GET /v1/projects/{project}/serviceAccounts ListServiceAccounts

Loading…
GET /v1/serviceAccounts/{serviceAccount} GetServiceAccount

Loading…
GET /v1/workspaces/{workspace}/serviceAccounts ListServiceAccounts

Loading…
PATCH /v1/serviceAccounts/{serviceAccount} UpdateServiceAccount

Loading…
POST /v1/projects/{project}/serviceAccounts CreateServiceAccount

Loading…
POST /v1/serviceAccounts/{serviceAccount}:undelete UndeleteServiceAccount

Loading…
POST /v1/workspaces/{workspace}/serviceAccounts CreateServiceAccount

Loading…

Sqlservice 8

GET /v1:adminExecute AdminExecute

Loading…
POST /bytebase.v1.SQLService/GetQueryHistory GetQueryHistory deprecated

Loading…
POST /bytebase.v1.SQLService/ListQueryHistories ListQueryHistories deprecated

Loading…
POST /bytebase.v1.SQLService/SearchQueryHistories SearchQueryHistories deprecated

Loading…
POST /v1/instances/{instance}/databases/{database}:export Export

Loading…
POST /v1/instances/{instance}/databases/{database}:query Query

Loading…
POST /v1/projects/{project}/instances/{instance}/databases/{database}:export Export

Loading…
POST /v1/projects/{project}/instances/{instance}/databases/{database}:query Query

Loading…

Workloadidentityservice 8

DELETE /v1/workloadIdentities/{workloadIdentity} DeleteWorkloadIdentity

Loading…
GET /v1/projects/{project}/workloadIdentities ListWorkloadIdentities

Loading…
GET /v1/workloadIdentities/{workloadIdentity} GetWorkloadIdentity

Loading…
GET /v1/workspaces/{workspace}/workloadIdentities ListWorkloadIdentities

Loading…
PATCH /v1/workloadIdentities/{workloadIdentity} UpdateWorkloadIdentity

Loading…
POST /v1/projects/{project}/workloadIdentities CreateWorkloadIdentity

Loading…
POST /v1/workloadIdentities/{workloadIdentity}:undelete UndeleteWorkloadIdentity

Loading…
POST /v1/workspaces/{workspace}/workloadIdentities CreateWorkloadIdentity

Loading…

Workspaceservice 8

DELETE /v1/workspaces/{workspace} DeleteWorkspace

Loading…
GET /v1/workspaces ListWorkspaces

Loading…
GET /v1/workspaces/{workspace} GetWorkspace

Loading…
GET /v1/workspaces/{workspace}:getIamPolicy GetIamPolicy

Loading…
PATCH /v1/workspaces/{workspace} UpdateWorkspace

Loading…
POST /v1/workspaces/{workspace}:leave LeaveWorkspace

Loading…
POST /v1/workspaces/{workspace}:rotateDirectorySyncToken RotateDirectorySyncToken

Loading…
POST /v1/workspaces/{workspace}:setIamPolicy SetIamPolicy

Loading…

Identityproviderservice 7

DELETE /v1/idps/{idp} DeleteIdentityProvider

Loading…
GET /v1/idps Lists the identity providers configured for the caller's workspace.

Loading…
GET /v1/idps/{idp} GetIdentityProvider

Loading…
GET /v1/workspaces/{workspace}/idps Lists the identity providers configured for the caller's workspace.

Loading…
PATCH /v1/idps/{idp} UpdateIdentityProvider

Loading…
POST /v1/idps CreateIdentityProvider

Loading…
POST /v1/idps/*:test TestIdentityProvider

Loading…

Planservice 7

GET /v1/projects/{project}/plans ListPlans

Loading…
GET /v1/projects/{project}/plans/{plan} GetPlan

Loading…
GET /v1/projects/{project}/plans/{plan}/planCheckRun GetPlanCheckRun

Loading…
PATCH /v1/projects/{project}/plans/{plan} UpdatePlan

Loading…
POST /v1/projects/{project}/plans CreatePlan

Loading…
POST /v1/projects/{project}/plans/{plan}/planCheckRun:cancel CancelPlanCheckRun

Loading…
POST /v1/projects/{project}/plans/{plan}:runPlanChecks RunPlanChecks

Loading…

Accessgrantservice 6

GET /v1/projects/{project}/accessGrants ListAccessGrants

Loading…
GET /v1/projects/{project}/accessGrants/{accessGrant} GetAccessGrant

Loading…
POST /v1/projects/{project}/accessGrants CreateAccessGrant

Loading…
POST /v1/projects/{project}/accessGrants/{accessGrant}:activate ActivateAccessGrant

Loading…
POST /v1/projects/{project}/accessGrants/{accessGrant}:revoke RevokeAccessGrant

Loading…
POST /v1/projects/{project}/accessGrants:searchMy SearchMyAccessGrants

Loading…

Groupservice 6

DELETE /v1/groups/{group} DeleteGroup

Loading…
GET /v1/groups ListGroups

Loading…
GET /v1/groups/{group} GetGroup

Loading…
GET /v1/groups:batchGet BatchGetGroups

Loading…
PATCH /v1/groups/{group} UpdateGroup

Loading…
POST /v1/groups CreateGroup

Loading…

Databasegroupservice 5

DELETE /v1/projects/{project}/databaseGroups/{databaseGroup} DeleteDatabaseGroup

Loading…
GET /v1/projects/{project}/databaseGroups ListDatabaseGroups

Loading…
GET /v1/projects/{project}/databaseGroups/{databaseGroup} GetDatabaseGroup

Loading…
PATCH /v1/projects/{project}/databaseGroups/{databaseGroup} UpdateDatabaseGroup

Loading…
POST /v1/projects/{project}/databaseGroups CreateDatabaseGroup

Loading…

Reviewconfigservice 5

DELETE /v1/reviewConfigs/{reviewConfig} DeleteReviewConfig

Loading…
GET /v1/reviewConfigs ListReviewConfigs

Loading…
GET /v1/reviewConfigs/{reviewConfig} GetReviewConfig

Loading…
PATCH /v1/reviewConfigs/{reviewConfig} UpdateReviewConfig

Loading…
POST /v1/reviewConfigs CreateReviewConfig

Loading…

Roleservice 5

DELETE /v1/roles/{role} DeleteRole

Loading…
GET /v1/roles ListRoles

Loading…
GET /v1/roles/{role} GetRole

Loading…
PATCH /v1/roles/{role} UpdateRole

Loading…
POST /v1/roles CreateRole

Loading…

Auditlogservice 4

POST /v1/auditLogs:export ExportAuditLogs

Loading…
POST /v1/auditLogs:search SearchAuditLogs

Loading…
POST /v1/projects/{project}/auditLogs:export ExportAuditLogs

Loading…
POST /v1/projects/{project}/auditLogs:search SearchAuditLogs

Loading…

Changelogservice 4

GET /v1/instances/{instance}/databases/{database}/changelogs ListChangelogs

Loading…
GET /v1/instances/{instance}/databases/{database}/changelogs/{changelog} GetChangelog

Loading…
GET /v1/projects/{project}/instances/{instance}/databases/{database}/changelogs ListChangelogs

Loading…
GET /v1/projects/{project}/instances/{instance}/databases/{database}/changelogs/{changelog} GetChangelog

Loading…

Databasecatalogservice 4

GET /v1/instances/{instance}/databases/{database}/catalog GetDatabaseCatalog

Loading…
GET /v1/projects/{project}/instances/{instance}/databases/{database}/catalog GetDatabaseCatalog

Loading…
PATCH /v1/instances/{instance}/databases/{database}/catalog UpdateDatabaseCatalog

Loading…
PATCH /v1/projects/{project}/instances/{instance}/databases/{database}/catalog UpdateDatabaseCatalog

Loading…

Settingservice 4

GET /v1/settings ListSettings

Loading…
GET /v1/settings/{setting} GetSetting

Loading…
PATCH /v1/settings/{setting} UpdateSetting

Loading…
POST /v1/workspaces/{workspace}/settings/EMAIL:test TestEmailSetting

Loading…

Queryhistoryservice 3

GET /v1/projects/{project}/queryHistories ListQueryHistories

Loading…
GET /v1/projects/{project}/queryHistories/{queryHistory} GetQueryHistory

Loading…
POST /v1/projects/{project}/queryHistories:search SearchQueryHistories

Loading…

Sheetservice 3

GET /v1/projects/{project}/sheets/{sheet} GetSheet

Loading…
POST /v1/projects/{project}/sheets CreateSheet

Loading…
POST /v1/projects/{project}/sheets:batchCreate BatchCreateSheets

Loading…

Celservice 2

POST /v1/cel/batchDeparse BatchDeparse

Loading…
POST /v1/cel/batchParse BatchParse

Loading…

Instanceroleservice 2

GET /v1/instances/{instance}/roles ListInstanceRoles

Loading…
GET /v1/projects/{project}/instances/{instance}/roles ListInstanceRoles

Loading…

Actuatorservice 1

GET /v1/actuator/info GetActuatorInfo

Loading…

Aiservice 1

POST /v1/ai/chat Chat

Loading…

Change log

2026-10-17
- +GET /v1/projects/{project}/issues/{issue}/reviewRuns/{reviewRun}