# PingCAP Import API

**Canonical:** https://apis.io/apis/pingcap/pingcap-import-api/  
**Provider:** PingCAP — https://apis.io/providers/pingcap/  
**Base URL:** https://serverless.tidbapi.com/v1beta1  
**Documentation:** https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/

PingCAP Import API is one of 32 APIs that [PingCAP](https://apis.io/providers/pingcap/) publishes on the [APIs.io](https://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.

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

## Operations (13)

| Method | Path | Summary |
|---|---|---|
| GET | `/clusters/{clusterId}/imports` | List import tasks |
| POST | `/clusters/{clusterId}/imports` | Create an import task |
| GET | `/clusters/{clusterId}/imports/{importId}` | Get an import task |
| POST | `/clusters/{clusterId}/imports/{importId}:cancel` | Cancel an import task |
| GET | `/clusters/{clusterId}/imports/{id}` | Get details of an import task |
| POST | `/clusters/{clusterId}/imports/{id}:cancel` | Cancel an import task |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports` | List all import tasks for a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports` | Create an import task. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/preview` | Preview data before starting an import task. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/role_info` | Retrieve the role information for import tasks on a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/upload_file` | Upload a local file for an import task. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}` | Get an import task. |
| PATCH | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}` | Update an import task. |

## Machine-readable artifacts (19)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-import-api-openapi.yml
- **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/
- **Sandbox** — https://zero.tidbcloud.com/
- **Documentation** — https://docs.pingcap.com/tidb/stable/dm-open-api/
- **SourceCode** — https://github.com/pingcap/tiflow/blob/master/dm/openapi/spec/dm.yaml
- **Documentation** — https://ossinsight.io/docs/api
- **SourceCode** — https://github.com/pingcap/ossinsight

## Other PingCAP APIs (12)

- [TiDB MCP Server](https://apis.io/apis/pingcap/tidb-mcp-server/)
- [PingCAP API Key API](https://apis.io/apis/pingcap/pingcap-api-key-api/)
- [PingCAP Audit Log API](https://apis.io/apis/pingcap/pingcap-audit-log-api/)
- [PingCAP Backup API](https://apis.io/apis/pingcap/pingcap-backup-api/)
- [PingCAP Billing API](https://apis.io/apis/pingcap/pingcap-billing-api/)
- [PingCAP Branch API](https://apis.io/apis/pingcap/pingcap-branch-api/)
- [PingCAP Changefeed API](https://apis.io/apis/pingcap/pingcap-changefeed-api/)
- [PingCAP Chat2 Query API](https://apis.io/apis/pingcap/pingcap-chat2query-api/)
- [PingCAP Cluster API](https://apis.io/apis/pingcap/pingcap-cluster-api/)
- [PingCAP Collections API](https://apis.io/apis/pingcap/pingcap-collections-api/)
- [PingCAP Data API Key API](https://apis.io/apis/pingcap/pingcap-data-api-key-api/)
- [PingCAP Data App API](https://apis.io/apis/pingcap/pingcap-data-app-api/)

## Tags

Import

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pingcap/pingcap-import-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pingcap/.