How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PingCAP Branch API

The Branch API from PingCAP — 3 operation(s) for branch.

PingCAP Branch API is one of 32 APIs that PingCAP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Branch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version v1beta1.

Requests are made against a single base URL, https://serverless.tidbapi.com/v1beta1.

5 operations 3 paths 10 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1beta1
Base URL
https://serverless.tidbapi.com/v1beta1
Resource Areas
1

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Branch 5
GET
/clusters/{clusterId}/branches
List branches
BranchService_ListBranches 3 params → 200400401403429500default
POST
/clusters/{clusterId}/branches
Create a branch
BranchService_CreateBranch 1 param body → 200400401403429500default
GET
/clusters/{clusterId}/branches/{branchId}
Get details of a branch
BranchService_GetBranch 3 params → 200400401403429500default
DELETE
/clusters/{clusterId}/branches/{branchId}
Delete a branch
BranchService_DeleteBranch 2 params → 200400401403429500default
POST
/clusters/{clusterId}/branches/{branchId}:reset
Reset a branch
BranchService_ResetBranch 2 params → 200400401403429500default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are v1beta1Branch (14 properties), v1beta1BranchEndpointsPublic (4 properties), v1beta1BranchEndpointsPrivate (3 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

v1beta1Branch
object
Message for branch.
14 properties 1 required
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
googlerpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
v1beta1BranchEndpointsPublic
object
Message for Public Endpoint for this branch.
4 properties
v1beta1ListBranchesResponse
object
Message for response to list branches.
3 properties
v1beta1BranchEndpointsPrivateAWS
object
Message for AWS Private Link Service.
2 properties
v1beta1BranchEndpointsPublicAuthorizedNetwork
object
3 properties
v1beta1BranchState
string
Branch State. - CREATING: The branch is creating. - ACTIVE: The branch is active and running. - DELETED: The branch is deleted. - RESTORING: The branch is rest…
v1beta1BranchEndpointsPrivate
object
Message for Private Endpoint for this branch.
3 properties
v1beta1BranchEndpoints
object
Message for the Endpoints for this branch.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-branch-api-openapi.yml Raw ↑

Other APIs PingCAP publishes across the network.

TiDB MCP Server
PingCAP API Key API
PingCAP Audit Log API
PingCAP Backup API
PingCAP Billing API
PingCAP Changefeed API
PingCAP Chat2 Query API
PingCAP Cluster API
PingCAP Collections API
PingCAP Data API Key API
PingCAP Data App API
PingCAP Data Source API
Where this information came from

This is an independent, third-party profile of PingCAP Branch API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.