tidb Diagnostics API

openapi: 3.1.0
info:
  title: TiDB Cloud API Keys Diagnostics API
  description: The TiDB Cloud API is a REST interface that provides programmatic access to manage administrative objects within TiDB Cloud. It supports managing projects, clusters, backups, restores, data imports, billing, and private endpoint connections across both TiDB Cloud Serverless and TiDB Cloud Dedicated tiers. The API uses HTTP Digest Authentication with public and private API keys and returns JSON-formatted responses. Available as both v1beta and the newer v1beta1 versions, it enables automation of database infrastructure lifecycle management at scale.
  version: v1beta1
  contact:
    name: TiDB Cloud Support
    url: https://docs.pingcap.com/tidbcloud/api-overview/
  termsOfService: https://www.pingcap.com/legal/privacy-policy/
servers:
- url: https://dedicated.tidbapi.com/v1beta1
  description: Dedicated Cluster API Server
- url: https://iam.tidbapi.com/v1beta1
  description: IAM API Server
- url: https://billing.tidbapi.com/v1beta1
  description: Billing API Server
security:
- digestAuth: []
tags:
- name: Diagnostics
  description: Endpoints for downloading debug information and managing server diagnostics.
paths:
  /debug/zip:
    get:
      operationId: downloadDebugZip
      summary: Download debug info zip
      description: Returns a zip archive containing TiDB debug information useful for diagnosing production issues. The archive includes heap profile, CPU profile, goroutine dump, and configuration information collected over the specified number of seconds. This endpoint is used when filing bug reports or investigating performance problems with PingCAP support.
      tags:
      - Diagnostics
      parameters:
      - name: seconds
        in: query
        description: Number of seconds to collect CPU profile and goroutine data before packaging.
        required: false
        schema:
          type: integer
          default: 10
      responses:
        '200':
          description: Debug zip archive returned successfully.
          content:
            application/zip:
              schema:
                type: string
                format: binary
                description: A zip file containing debug information.
components:
  securitySchemes:
    digestAuth:
      type: http
      scheme: digest
      description: HTTP Digest Authentication using a TiDB Cloud API public key as the username and private key as the password. Keys are generated in the TiDB Cloud console under Organization Settings > API Keys.
externalDocs:
  description: TiDB Cloud API Overview
  url: https://docs.pingcap.com/tidbcloud/api-overview/