Bytebase Docs home page

GitHub
bytebase.com
bytebase.com

ProjectService

GET
Get v1* iampolicies:batchget
GET
Get v1projects
POST
Post v1projects
GET
Get v1projects 1
DEL
Delete v1projects
PATCH
Patch v1projects
POST
Post v1projects webhooks :removewebhook
POST
Post v1projects webhooks :updatewebhook
POST
Post v1projects :addwebhook
GET
Get v1projects :getiampolicy
POST
Post v1projects :setiampolicy
POST
Post v1projects :testwebhook
POST
Post v1projects :undelete
POST
Post v1projects:batchdelete
POST
Post v1projects:search

ActuatorService

DEL
Delete v1actuatorcache
GET
Get v1actuatorinfo
PATCH
Patch v1actuatorinfo
GET
Get v1actuatorresources
POST
Post v1actuator:setupsample

AuditLogService

POST
Post v1auditlogs:export
POST
Post v1auditlogs:search
POST
Post v1projects auditlogs:export
POST
Post v1projects auditlogs:search

AuthService

POST
Post v1authlogin
POST
Post v1authlogout

CelService

POST
Post v1celbatchdeparse
POST
Post v1celbatchparse

OrgPolicyService

GET
Get v1environments policies
POST
Post v1environments policies
GET
Get v1environments policies 1
DEL
Delete v1environments policies
PATCH
Patch v1environments policies
GET
Get v1instances databases policies
POST
Post v1instances databases policies
GET
Get v1instances databases policies 1
DEL
Delete v1instances databases policies
PATCH
Patch v1instances databases policies
GET
Get v1instances policies
POST
Post v1instances policies
GET
Get v1instances policies 1
DEL
Delete v1instances policies
PATCH
Patch v1instances policies
GET
Get v1policies
POST
Post v1policies
GET
Get v1policies 1
DEL
Delete v1policies
PATCH
Patch v1policies
GET
Get v1projects policies
POST
Post v1projects policies
GET
Get v1projects policies 1
DEL
Delete v1projects policies
PATCH
Patch v1projects policies

GroupService

GET
Get v1groups
POST
Post v1groups
GET
Get v1groups 1
DEL
Delete v1groups
PATCH
Patch v1groups

IdentityProviderService

GET
Get v1idps
POST
Post v1idps
POST
Post v1idps*:test
GET
Get v1idps 1
DEL
Delete v1idps
PATCH
Patch v1idps

InstanceService

GET
Get v1instances
POST
Post v1instances
GET
Get v1instances 1
DEL
Delete v1instances
PATCH
Patch v1instances
POST
Post v1instances :adddatasource
POST
Post v1instances :databases
POST
Post v1instances :removedatasource
POST
Post v1instances :sync
POST
Post v1instances :undelete
PATCH
Patch v1instances :updatedatasource
POST
Post v1instances:batchsync
POST
Post v1instances:batchupdate

DatabaseService

GET
Get v1instances databases
GET
Get v1instances databases 1
PATCH
Patch v1instances databases
GET
Get v1instances databases changelogs
GET
Get v1instances databases changelogs 1
POST
Post v1instances databases changelogs :diffschema
GET
Get v1instances databases metadata
GET
Get v1instances databases schema
GET
Get v1instances databases schemastring
GET
Get v1instances databases secrets
DEL
Delete v1instances databases secrets
PATCH
Patch v1instances databases secrets
POST
Post v1instances databases :diffschema
POST
Post v1instances databases :sync
GET
Get v1instances databases:batchget
POST
Post v1instances databases:batchsync
POST
Post v1instances databases:batchupdate
GET
Get v1projects databases
GET
Get v1projects databases:batchget
GET
Get v1workspaces databases

DatabaseCatalogService

GET
Get v1instances databases catalog
PATCH
Patch v1instances databases catalog

RevisionService

GET
Get v1instances databases revisions
POST
Post v1instances databases revisions
GET
Get v1instances databases revisions 1
DEL
Delete v1instances databases revisions
POST
Post v1instances databases revisions:batchcreate

SQLService

POST
Post v1instances databases :export
POST
Post v1instances databases :query
POST
Post v1instances :export
POST
Post v1instances :query
POST
Post v1projects rollouts stages :export
POST
Post v1projects rollouts :export
POST
Post v1queryhistories:search
POST
Post v1schemadesign:diffmetadata
POST
Post v1sqlaicompletion
POST
Post v1sqlcheck
POST
Post v1sqlpretty
GET
Get v1:adminexecute

InstanceRoleService

GET
Get v1instances roles
GET
Get v1instances roles 1

ChangelistService

GET
Get v1projects changelists
POST
Post v1projects changelists
GET
Get v1projects changelists 1
DEL
Delete v1projects changelists
PATCH
Patch v1projects changelists

DatabaseGroupService

GET
Get v1projects databasegroups
POST
Post v1projects databasegroups
GET
Get v1projects databasegroups 1
DEL
Delete v1projects databasegroups
PATCH
Patch v1projects databasegroups

IssueService

GET
Get v1projects issues
POST
Post v1projects issues
GET
Get v1projects issues 1
PATCH
Patch v1projects issues
GET
Get v1projects issues issuecomments
POST
Post v1projects issues :approve
POST
Post v1projects issues :comment
PATCH
Patch v1projects issues :comment
POST
Post v1projects issues :reject
POST
Post v1projects issues :request
POST
Post v1projects issues:batchupdatestatus
POST
Post v1projects issues:search

PlanService

GET
Get v1projects plans
POST
Post v1projects plans
GET
Get v1projects plans 1
PATCH
Patch v1projects plans
GET
Get v1projects plans plancheckruns
POST
Post v1projects plans plancheckruns:batchcancel
POST
Post v1projects plans :runplanchecks
POST
Post v1projects plans:search

ReleaseService

GET
Get v1projects releases
POST
Post v1projects releases
GET
Get v1projects releases 1
DEL
Delete v1projects releases
PATCH
Patch v1projects releases
POST
Post v1projects releases :undelete
POST
Post v1projects releases:check

RolloutService

GET
Get v1projects rollouts
POST
Post v1projects rollouts
GET
Get v1projects rollouts 1
GET
Get v1projects rollouts stages tasks taskruns
GET
Get v1projects rollouts stages tasks taskruns 1
GET
Get v1projects rollouts stages tasks taskruns log
GET
Get v1projects rollouts stages tasks taskruns session
POST
Post v1projects rollouts stages tasks taskruns :previewrollback
POST
Post v1projects rollouts stages tasks taskruns:batchcancel
POST
Post v1projects rollouts stages tasks:batchrun
POST
Post v1projects rollouts stages tasks:batchskip
POST
Post v1projects :previewrollout

SheetService

POST
Post v1projects sheets
GET
Get v1projects sheets
PATCH
Patch v1projects sheets
POST
Post v1projects sheets:batchcreate

ReviewConfigService

GET
Get v1reviewconfigs
POST
Post v1reviewconfigs
GET
Get v1reviewconfigs 1
DEL
Delete v1reviewconfigs
PATCH
Patch v1reviewconfigs

RiskService

GET
Get v1risks
POST
Post v1risks
GET
Get v1risks 1
DEL
Delete v1risks
PATCH
Patch v1risks

RoleService

GET
Get v1roles
POST
Post v1roles
GET
Get v1roles 1
DEL
Delete v1roles
PATCH
Patch v1roles

SettingService

GET
Get v1settings
GET
Get v1settings 1
PATCH
Patch v1settings

SubscriptionService

GET
Get v1subscription
PATCH
Patch v1subscription

UserService

GET
Get v1users
POST
Post v1users
GET
Get v1usersme
GET
Get v1users 1
DEL
Delete v1users
PATCH
Patch v1users
POST
Post v1users :undelete
GET
Get v1users:batchget

WorksheetService

POST
Post v1worksheets
GET
Get v1worksheets
DEL
Delete v1worksheets
PATCH
Patch v1worksheets
PATCH
Patch v1worksheets organizer
POST
Post v1worksheets:search

WorkspaceService

GET
Get v1workspaces :getiampolicy
POST
Post v1workspaces :setiampolicy

UserService

Delete v1users

Only the user with bb.users.delete permission on the workspace can delete the user. The last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete

DELETE

/

v1

/

users

/

{user}

Copy

Ask AI

This response has no body data.

Path Parameters

user

string

required

The user id.

Was this page helpful?

Get v1users 1 Patch v1users

x github linkedin

Powered by Mintlify

Copy

Ask AI

This response has no body data.

Assistant

Responses are generated using AI and may contain mistakes.