PingCAP

PingCAP Backup API

Create, get, modify, and delete backups for TiDB clusters. For TiDB Cloud Starter instances, you cannot create or manage backups via API. You can use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as backups.

GitHub OpenAPI

Operations 11

GET /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups List all backups for a cluster #
POST /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups Create a backup for a cluster #
GET /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id} Get a backup for a cluster #
DELETE /api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id} Delete a backup for a cluster #
GET /tidbs/{tidbId}/backups List backups for a TiDB Cloud Premium instance #
POST /tidbs/{tidbId}/backups Create a backup for a TiDB Cloud Premium instance #
DELETE /tidbs/{tidbId}/backups/{backupId} Delete a backup for a TiDB Cloud Premium instance #
POST /tidbs:restore Restore a TiDB Cloud Premium instance from a backup #
GET /tidbs/{tidbId}:getRestoreStatus Get the restore status for a TiDB Cloud Premium instance #
GET /backups List backups #
DELETE /backups/{backupId} Delete a backup #

Documentation

📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
📖
Documentation
https://docs.pingcap.com/tidbcloud/api/v1beta/
📖
APIReference
https://docs.pingcap.com/tidbcloud/api/v1beta/
📖
Documentation
https://zero.tidbcloud.com/
📖
Documentation
https://docs.pingcap.com/tidb/stable/dm-open-api/
📖
Documentation
https://ossinsight.io/docs/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-backup-api-openapi.yml

Other Resources

🔗
Sandbox
https://zero.tidbcloud.com/
🔗
SourceCode
https://github.com/pingcap/tiflow/blob/master/dm/openapi/spec/dm.yaml
🔗
SourceCode
https://github.com/pingcap/ossinsight

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pingcap-backup-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pingcap-backup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pingcap Backup API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Backup across 2 of this provider''s published API definitions: pingcap-tidb-cloud-v1beta-openapi-original.json, tidb-cloud-premium-v1beta2-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.tidbcloud.com
- url: https://cloud.tidbapi.com/v1beta2
tags:


# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-backup-api-openapi.yml