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 Import API

List import tasks, create an import task, get an import task, and cancel an import task.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Import. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://serverless.tidbapi.com/v1beta1.

13 operations 10 paths 44 schemas 6 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://serverless.tidbapi.com/v1beta1
Resource Areas
1

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 6 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Import 13

List import tasks, create an import task, get an import task, and cancel an import task.

GET
/clusters/{clusterId}/imports
List import tasks
ListImports 4 params → 200default
POST
/clusters/{clusterId}/imports
Create an import task
CreateImport 2 params → 200default
GET
/clusters/{clusterId}/imports/{importId}
Get an import task
GetImport 2 params → 200default
POST
/clusters/{clusterId}/imports/{importId}:cancel
Cancel an import task
CancelImport 3 params → 200default
GET
/clusters/{clusterId}/imports/{id}
Get details of an import task
ImportService_GetImport 2 params → 200400401403429500default
POST
/clusters/{clusterId}/imports/{id}:cancel
Cancel an import task
ImportService_CancelImport 2 params → 200400401403429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports
List all import tasks for a cluster.
ListImportTasks 4 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports
Create an import task.
CreateImportTask 3 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/preview
Preview data before starting an import task.
PreviewImportData 3 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/role_info
Retrieve the role information for import tasks on a cluster.
GetImportTaskRoleInfo 2 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/upload_file
Upload a local file for an import task.
UploadLocalFile 3 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}
Get an import task.
GetImportTask 3 params → 200400401403404429500default
PATCH
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}
Update an import task.
UpdateImportTask 4 params → 200400401403404429500default

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are v1beta1Import_2 (12 properties), v1beta1Import (11 properties), v1beta1CSVFormat (7 properties), v1beta1ImportOptionsCSVFormat (7 properties). Each schema is shown below with its type and property counts.

v1beta1ImportSource
object
The source of the import.
4 properties 1 required
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
v1beta1ImportOptions
object
The options of the import task.
4 properties 1 required
v1beta1Import
object
The import.
11 properties 1 required
v1beta1ImportValidationItem
string
The validation item of the import. - IMPORTVALIDATIONITEMUNSPECIFIED: The validation item is unspecified. - SOURCEACCESSCHECK: The validation item is source ac…
v1beta1S3Source
object
The S3 source of the import.
4 properties 2 required
v1beta1ImportS3AuthTypeEnum_2
string
- ROLEARN: The access method is role arn. - ACCESSKEY: The access method is access key.
v1beta1Import_2
object
12 properties
v1beta1OSSSourceAccessKey
object
2 properties 2 required
v1beta1CreationDetails_2
object
2 properties
v1beta1ImportGcsAuthTypeEnum
string
The type of the access method. - UNSPECIFIED: The access method is unknown. - SERVICEACCOUNTKEY: The access method is service account key.
v1beta1GCSSource_2
object
3 properties 2 required
v1beta1ImportAzureBlobAuthTypeEnum
string
The type of the access method. - UNSPECIFIED: The access method is unknown. - SASTOKEN: The access method is sas token.
v1beta1ImportTargetTableInfo
object
The target table info of the import task.
3 properties
v1beta1ImportSourceTypeEnum
string
The source type of the import. - UNSPECIFIED: Indicates that the import source is not specified. - S3: Indicates that the import source is an AWS S3 resource.…
v1beta1S3CompatibleSource
object
4 properties 2 required
v1beta1S3CompatibleSourceAccessKey
object
2 properties 2 required
commonTable
object
2 properties
v1beta1OSSSource
object
3 properties 2 required
v1beta1ImportFileTypeEnum_2
string
- CSV: CSV type. - SQL: SQL type. - AURORASNAPSHOT: Aurora snapshot type. - PARQUET: Parquet type.
v1beta1ImportOSSAuthTypeEnum
string
- ACCESSKEY: The access method is access key.
v1beta1S3SourceAccessKey
object
2 properties 2 required
v1beta1ImportStateEnum
string
The state of the import. - UNSPECIFIED: Indicates that the import state is not specified. - PREPARING: Indicates that the import is being prepared. - IMPORTING…
v1beta1ImportSource_2
object
6 properties 1 required
v1beta1ListImportsResponse
object
The response message for listing imports.
3 properties
v1beta1ImportAzureBlobAuthTypeEnum_2
string
- SASTOKEN: The access method is sas token.
v1beta1S3Source_2
object
4 properties 2 required
v1beta1CreationDetails
object
The details of the import.
4 properties 2 required
v1beta1ImportS3AuthTypeEnum
string
The type of the access method. - UNSPECIFIED: The access method is unknown. - ROLEARN: The access method is role arn. - ACCESSKEY: The access method is access…
S3SourceAccessKey
object
The access key of the import source.
2 properties 2 required
v1beta1ImportStateEnum_2
string
- PREPARING: The import is preparing. - IMPORTING: The import is importing. - COMPLETED: The import is completed. - FAILED: The import is failed. - CANCELING:…
v1beta1AzureBlobSource
object
The Azure Blob Storage source of the import.
3 properties 2 required
v1beta1ImportFileTypeEnum
string
The type of the file. - UNSPECIFIED: The type of the file is unknown. - CSV: CSV type. - SQL: SQL type. - AURORASNAPSHOT: Aurora snapshot type. - PARQUET: Parq…
v1beta1ImportOptionsCSVFormat
object
7 properties
v1beta1ImportGcsAuthTypeEnum_2
string
- SERVICEACCOUNTKEY: The access method is service account key.
v1beta1ImportOptions_2
object
2 properties 1 required
rpcStatus
object
3 properties
v1beta1CSVFormat
object
The format of the CSV file.
7 properties
v1beta1DuplicationHandlingForSQLEnum
string
The duplication handling for SQL. - UNSPECIFIED: The duplication handling for SQL is unknown. - REPLACE: The duplication handling for SQL is replace. - IGNORE:…
v1beta1ImportSourceTypeEnum_2
string
- S3: S3 source. - GCS: gcs source. - AZUREBLOB: azure blob source. - S3COMPATIBLE: S3 compatible source. - OSS: OSS source.
v1beta1GCSSource
object
The Google Cloud Storage source of the import.
3 properties 2 required
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
v1beta1ImportS3CompatibleAuthTypeEnum
string
- ACCESSKEY: The access method is access key.
v1beta1AzureBlobSource_2
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-import-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
#Import
← Back to P APIs
API Details
ID
pingcap:pingcap-import-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-import-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pingcap-import-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 Import 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.