PingCAP

PingCAP Doc API

The doc API from PingCAP — 2 operation(s) for doc.

GitHub OpenAPI

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-doc-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

OpenAPI Specification

pingcap-doc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DM OpenAPI Doc API
  version: 6.0.0
servers:
- url: https://you.domain.com/
tags:
- name: doc
paths:
  /api/v1/docs:
    get:
      tags:
      - doc
      summary: get doc html
      operationId: GetDocHTML
      responses:
        '200':
          description: HTML content
  /api/v1/dm.json:
    get:
      tags:
      - doc
      summary: get doc json
      operationId: GetDocJSON
      responses:
        '200':
          description: json content
externalDocs:
  description: DM OpenAPI DOC
  url: https://docs.pingcap.com/zh/tidb-data-migration/stable