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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PingCAP

PingCAP Export API

The Export API from PingCAP — 3 operation(s) for export.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Export. 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 26 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 26 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.

Export 5
GET
/clusters/{clusterId}/exports
List export tasks for a TiDB Cloud Starter or Essential instance
ExportService_ListExports 4 params → 200400401403429500default
POST
/clusters/{clusterId}/exports
Create an export task
ExportService_CreateExport 1 param body → 200400401403429500default
GET
/clusters/{clusterId}/exports/{exportId}
Get details of an export task
ExportService_GetExport 2 params → 200400401403429500default
DELETE
/clusters/{clusterId}/exports/{exportId}
Delete an export task
ExportService_DeleteExport 2 params → 200400401403429500default
POST
/clusters/{clusterId}/exports/{exportId}:cancel
Cancel an export task
ExportService_CancelExport 2 params → 200400401403429500default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are v1beta1Export (14 properties), v1beta1ExportTarget (5 properties), v1beta1ExportOptions (5 properties), v1beta1S3Target (4 properties). Each schema is shown below with its type and property counts.

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
v1beta1ExportStateEnum
string
Export State. - RUNNING: The export task is being created. - SUCCEEDED: The export task is success. - FAILED: The export task is failed. - CANCELED: The export…
ExportOptionsParquetFormat
object
1 property
v1beta1ExportS3AuthTypeEnum
string
- ROLEARN: The access method is role arn. - ACCESSKEY: The access method is access key.
v1beta1OSSTarget
object
3 properties 2 required
v1beta1ExportFileTypeEnum
string
- SQL: SQL type. - CSV: CSV type. - PARQUET: PARQUET type.
ExportServiceCreateExportBody
object
3 properties
v1beta1ListExportsResponse
object
3 properties
v1beta1ExportOptions
object
5 properties
v1beta1AzureBlobTarget
object
3 properties 2 required
v1beta1S3Target
object
4 properties 1 required
v1beta1ExportOptionsCSVFormat
object
4 properties
v1beta1OSSTargetAccessKey
object
2 properties 2 required
ExportOptionsFilterTable
object
2 properties
v1beta1ExportAzureBlobAuthTypeEnum
string
- SASTOKEN: The access method is sas token.
v1beta1ExportTargetTypeEnum
string
- LOCAL: Local target. - S3: S3 target. - GCS: gcs target. - AZUREBLOB: azure blob target. - OSS: OSS target.
v1beta1ExportOptionsFilter
object
2 properties
v1beta1ExportOSSAuthTypeEnum
string
- ACCESSKEY: The access method is access key.
v1beta1GCSTarget
object
3 properties 2 required
v1beta1ExportGcsAuthTypeEnum
string
- SERVICEACCOUNTKEY: The access method is service account key.
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
v1beta1Export
object
Message for export task.
14 properties 1 required
v1beta1ExportCompressionTypeEnum
string
- GZIP: Gzip compression. - SNAPPY: Snappy compression. - ZSTD: Zstd compression. - NONE: No compression.
v1beta1ExportTarget
object
5 properties
v1beta1S3TargetAccessKey
object
2 properties 2 required
v1beta1ExportParquetCompressionTypeEnum
string
- GZIP: The parquet compression type is GZIP. - SNAPPY: The parquet compression type is SNAPPY. - ZSTD: The parquet compression type is ZSTD. - NONE: No compre…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-export-api-openapi.yml Raw ↑

Other APIs PingCAP publishes across the network.

TiDB MCP Server
AE Profile APIs.io
PingCAP API Key API
AE Profile APIs.io
PingCAP Audit Log API
AE Profile APIs.io
PingCAP Backup API
AE Profile APIs.io
PingCAP Billing API
AE Profile APIs.io
PingCAP Branch API
AE Profile APIs.io
PingCAP Changefeed API
AE Profile APIs.io
PingCAP Chat2 Query API
AE Profile APIs.io
PingCAP Cluster API
AE Profile APIs.io
PingCAP Collections API
AE Profile APIs.io
PingCAP Data API Key API
AE Profile APIs.io
PingCAP Data App API
AE Profile APIs.io
#Export
← Back to P APIs
API Details
ID
pingcap:pingcap-export-api
Base URL
https://serverless.tidbapi.com/v1beta1
Docs
https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
Provider
PingCAP
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pingcap-export-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pingcap-export-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of PingCAP Export 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.