PingCAP

aid: pingcap
name: PingCAP
description: PingCAP is the company behind TiDB, an open-source, MySQL-compatible distributed SQL database built for hybrid
  transactional and analytical processing (HTAP), horizontal scale-out, Raft-based strong consistency, and vector search for
  AI workloads. PingCAP operates TiDB Cloud, the fully managed DBaaS delivered in Starter, Essential, Premium, Dedicated,
  BYOC and Lake tiers across AWS, Google Cloud, Azure and Alibaba Cloud. Developers manage the platform programmatically through
  the TiDB Cloud REST API family (cluster, branch, import, export, changefeed, IAM, billing and Data Service surfaces), the
  `ticloud` CLI, a Terraform provider, the TiDB Cloud Serverless JavaScript driver, the PyTiDB Python SDK, and an official
  TiDB MCP Server for agents. PingCAP also publishes OpenAPI for the TiDB Data Migration (DM) control plane and the OSS Insight
  public API.
image: https://static.pingcap.com/files/2024/09/11005522/Homepage-Ad.png
url: https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/apis.yml
x-type: company
x-source: harvest:secondary-market
specificationVersion: '0.21'
created: '2026-08-02'
modified: '2026-08-02'
tags:
- distributed-sql
- database
- tidb
- htap
- mysql-compatible
- cloud-database
- dbaas
- vector-search
- data-migration
- change-data-capture
- open-source
- infrastructure
apis:
- name: TiDB Cloud Starter and Essential API (v1beta1)
  description: 'REST API for managing TiDB Cloud Starter and TiDB Cloud Essential instances: cluster lifecycle, database branches,
    data export tasks and data import tasks. HTTPS-only, JSON entities, HTTP Digest authentication with an organization API
    key pair, 100 requests per minute per key.'
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
  baseURL: https://serverless.tidbapi.com/v1beta1
  tags:
  - distributed-sql
  - database
  - tidb
  - dbaas
  - cloud-database
  - serverless
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-starter-essential-v1beta1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-starter-essential-overlay.yaml
- name: TiDB Cloud Dedicated API (v1beta1)
  description: 'REST API for managing TiDB Cloud Dedicated clusters: cluster CRUD, pause/resume, root password reset, node
    quota, regions and node specs, private endpoint connections, data imports, third-party integrations and changefeeds (change
    data capture to downstream systems).'
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
  baseURL: https://dedicated.tidbapi.com/v1beta1
  tags:
  - distributed-sql
  - database
  - tidb
  - dbaas
  - cloud-database
  - change-data-capture
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-dedicated-v1beta1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-dedicated-overlay.yaml
- name: TiDB Cloud IAM API (v1beta1)
  description: 'REST API for TiDB Cloud identity and access management: create, list, update and delete organization API keys,
    list audit logs, and manage organization members and their roles including batch updates and invitation resend.'
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
  baseURL: https://iam.tidbapi.com/v1beta1
  tags:
  - identity
  - access-management
  - api-keys
  - audit-log
  - tidb
  - cloud-database
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-iam-v1beta1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-iam-overlay.yaml
- name: TiDB Cloud Billing API (v1beta1)
  description: 'REST API for TiDB Cloud billing: retrieve the monthly bill for an organization, retrieve line-item bill details,
    and query the cost explorer with supported grouping and filter arguments.'
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
  baseURL: https://billing.tidbapi.com/v1beta1
  tags:
  - billing
  - finops
  - cost-management
  - tidb
  - cloud-database
  - dbaas
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-billing-v1beta1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-billing-overlay.yaml
- name: TiDB Cloud Data Service API (v1beta1)
  description: 'REST API for TiDB Cloud Data Service: manage Data Apps, data sources, custom HTTP endpoints backed by SQL,
    deployments and Data API keys. Data Service also generates an OpenAPI 3.0 specification per Data App so the endpoints
    you author can be consumed as a standard machine-readable contract.'
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
  baseURL: https://dataservice.tidbapi.com/v1beta1
  tags:
  - data-service
  - low-code
  - sql
  - rest
  - tidb
  - cloud-database
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-data-service-v1beta1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-data-service-overlay.yaml
- name: TiDB Cloud API (v1beta, legacy)
  description: The original TiDB Cloud administrative REST API covering projects, clusters, backups, restores and the deprecated
    import surface. Superseded by the v1beta1 tier-specific APIs but still documented and callable at api.tidbcloud.com with
    HTTP Digest authentication.
  humanURL: https://docs.pingcap.com/tidbcloud/api/v1beta/
  baseURL: https://api.tidbcloud.com/api/v1beta
  tags:
  - distributed-sql
  - database
  - tidb
  - dbaas
  - cloud-database
  - backup
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: APIReference
    url: https://docs.pingcap.com/tidbcloud/api/v1beta/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-v1beta-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-v1beta-overlay.yaml
- name: TiDB Cloud Zero API (v1alpha1)
  description: Unauthenticated REST API that provisions a disposable, MySQL-compatible TiDB database in a single call. Instances
    auto-expire after 30 days unless claimed into a regular TiDB Cloud Starter instance. Used as the zero-friction playground
    and as the provisioning surface behind the published tidb-cloud-zero agent skill.
  humanURL: https://zero.tidbcloud.com/
  baseURL: https://zero.tidbapi.com/v1alpha1
  tags:
  - sandbox
  - playground
  - tidb
  - database
  - mysql-compatible
  - ephemeral
  properties:
  - type: Documentation
    url: https://zero.tidbcloud.com/
  - type: OpenAPI
    url: openapi/pingcap-tidb-cloud-zero-v1alpha1-openapi-original.json
  - type: Overlay
    url: overlays/pingcap-tidb-cloud-zero-overlay.yaml
  - type: Sandbox
    url: https://zero.tidbcloud.com/
- name: TiDB Data Migration (DM) OpenAPI
  description: OpenAPI 3.0 control-plane API for TiDB Data Migration, the platform that replicates MySQL-compatible upstreams
    into TiDB. Covers upstream source registration, relay log control, migration task lifecycle and status, task templates,
    table-structure operations and DM cluster master/worker membership. Served by dm-master in a self-managed DM deployment.
  humanURL: https://docs.pingcap.com/tidb/stable/dm-open-api/
  baseURL: https://docs.pingcap.com/tidb/stable/dm-open-api/
  tags:
  - data-migration
  - replication
  - tidb
  - mysql-compatible
  - open-source
  - etl
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/tidb/stable/dm-open-api/
  - type: OpenAPI
    url: openapi/pingcap-tidb-dm-openapi-original.yaml
  - type: Overlay
    url: overlays/pingcap-tidb-dm-overlay.yaml
  - type: SourceCode
    url: https://github.com/pingcap/tiflow/blob/master/dm/openapi/spec/dm.yaml
- name: OSS Insight Public API
  description: Public read-only REST API behind OSS Insight, the PingCAP-built open-source analytics service that queries
    billions of GitHub events stored in TiDB. Exposes repository, developer, organization, collection and trending analytics
    endpoints used by the ossinsight.io site and by third parties.
  humanURL: https://ossinsight.io/docs/api
  baseURL: https://api.ossinsight.io/v1
  tags:
  - open-source
  - analytics
  - github
  - developer-data
  - tidb
  - insights
  properties:
  - type: Documentation
    url: https://ossinsight.io/docs/api
  - type: OpenAPI
    url: openapi/pingcap-ossinsight-public-api-openapi-original.yaml
  - type: Overlay
    url: overlays/pingcap-ossinsight-overlay.yaml
  - type: SourceCode
    url: https://github.com/pingcap/ossinsight
- name: TiDB MCP Server
  description: Official Model Context Protocol server maintained by PingCAP that exposes a TiDB or TiDB Cloud database to
    MCP-capable agents and IDEs. Ships in the pytidb package, runs over stdio by default or SSE with --transport sse, and
    provides schema introspection, read query execution, DML/DDL execution and database user management.
  humanURL: https://docs.pingcap.com/ai/tidb-mcp-server/
  baseURL: https://docs.pingcap.com/ai/tidb-mcp-server/
  tags:
  - mcp
  - agent-native
  - ai
  - tidb
  - database
  - vector-search
  properties:
  - type: Documentation
    url: https://docs.pingcap.com/ai/tidb-mcp-server/
  - type: MCPServer
    url: mcp/pingcap-mcp.yml
  - type: ToolCrosswalk
    url: mcp/pingcap-tool-crosswalk.yml
  - type: SourceCode
    url: https://github.com/pingcap/pytidb
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: AgenticAccess
  url: agentic-access/pingcap-agentic-access.yml
- type: TrustCenter
  url: security/pingcap-trust-center.yml
- type: Website
  url: https://www.pingcap.com/
- type: DeveloperPortal
  url: https://docs.pingcap.com/
- type: Documentation
  url: https://docs.pingcap.com/tidbcloud/
- type: APIReference
  url: https://docs.pingcap.com/tidbcloud/api-overview/
- type: GettingStarted
  url: https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart/
- type: Support
  url: https://tidb.support.pingcap.com/servicedesk/customer/portals
- type: HelpCenter
  url: https://tidb.support.pingcap.com/servicedesk/customer/portals
- type: Blog
  url: https://www.pingcap.com/blog/
- type: GitHubOrganization
  url: https://github.com/pingcap
- type: SourceCode
  url: https://github.com/pingcap/tidb
- type: Pricing
  url: https://www.pingcap.com/pricing/
- type: SignUp
  url: https://tidbcloud.com/free-trial
- type: Login
  url: https://tidbcloud.com/signin
- type: TermsOfService
  url: https://www.pingcap.com/legal/tidb-cloud-services-agreement/
- type: PrivacyPolicy
  url: https://www.pingcap.com/privacy-policy/
- type: Compliance
  url: https://www.pingcap.com/trust-hub/
- type: TrustCenter
  url: https://www.pingcap.com/trust-hub/
- type: SLA
  url: https://www.pingcap.com/legal/service-level-agreement-for-tidb-cloud-services/
- type: StatusPage
  url: https://status.tidbcloud.com/
- type: Security
  url: https://www.pingcap.com/security/
- type: ChangeLog
  url: https://docs.pingcap.com/tidbcloud/tidb-cloud-release-notes/
- type: Community
  url: https://discord.com/invite/KVRZBR2DrG
- type: LLMsTxt
  url: llms/pingcap-llms.txt
- type: WellKnown
  url: well-known/pingcap-well-known.yml
- type: Packages
  url: packages/pingcap-packages.yml
- type: SDKs
  url: packages/pingcap-packages.yml
- type: CLI
  url: cli/pingcap-cli.yml
- type: Sandbox
  url: sandbox/pingcap-sandbox.yml
- type: MCPServer
  url: mcp/pingcap-mcp.yml
- type: ToolCrosswalk
  url: mcp/pingcap-tool-crosswalk.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Authentication
  url: authentication/pingcap-authentication.yml
- type: Conventions
  url: conventions/pingcap-conventions.yml
- type: RateLimits
  url: rate-limits/pingcap-rate-limits.yml
- type: ErrorCatalog
  url: errors/pingcap-problem-types.yml
- type: ErrorCodes
  url: errors/pingcap-error-codes.yml
- type: Lifecycle
  url: lifecycle/pingcap-lifecycle.yml
- type: Conformance
  url: conformance/pingcap-conformance.yml
- type: DataModel
  url: data-model/pingcap-data-model.yml
- type: DomainSecurity
  url: security/pingcap-domain-security.yml
- type: VulnerabilityDisclosure
  url: security/pingcap-vulnerability-disclosure.yml
- type: ChangeLog
  url: changelog/pingcap-changelog.yml
x-enrichment:
  date: '2026-08-02'
  status: enriched
  artifacts_added: 48
  pass: local-v1