# PingCAP Task API

**Canonical:** https://apis.io/apis/pingcap/pingcap-task-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 Task 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 Task. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

task

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/tasks` | create a task |
| GET | `/api/v1/tasks` | get task list |
| GET | `/api/v1/tasks/{task-name}` | get a task |
| DELETE | `/api/v1/tasks/{task-name}` | delete a task |
| PUT | `/api/v1/tasks/{task-name}` | update a task |
| GET | `/api/v1/tasks/{task-name}/status` | get task status |
| POST | `/api/v1/tasks/{task-name}/start` | start a task |
| POST | `/api/v1/tasks/{task-name}/stop` | stop a task |
| GET | `/api/v1/tasks/{task-name}/sources/{source-name}/migrate_targets` | get task source table and target table route relation |
| GET | `/api/v1/tasks/{task-name}/sources/{source-name}/schemas` | get task source schema list |
| GET | `/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}` | get task source table list |
| GET | `/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}` | get task source table structure |
| PUT | `/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}` | operate task source table structure |
| DELETE | `/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}` | delete task source table structure |
| POST | `/api/v1/tasks/converters` | Turn task into the format of a configuration file or vice versa. |
| POST | `/api/v1/tasks/templates` | create task template |
| GET | `/api/v1/tasks/templates` | get task template list |
| POST | `/api/v1/tasks/templates/import` | import task template |
| GET | `/api/v1/tasks/templates/{task-name}` | get task template template |
| PUT | `/api/v1/tasks/templates/{task-name}` | update task template template |
| DELETE | `/api/v1/tasks/templates/{task-name}` | delete task template template |

## Machine-readable artifacts (19)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-task-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

Task

---

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