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

task

Documentation Provider Profile APIs.io OpenAPI GitHub

PingCAP Task API is one of 32 APIs that PingCAP publishes on the 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.

This API exposes 21 operations across 13 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 6.0.0.

Requests are made against a single base URL, https://you.domain.com/.

21 operations 13 paths 36 schemas 3 DELETE9 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 21

Across 13 paths, the API surfaces 21 operations — 3 DELETE, 9 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

task 21

task

POST
/api/v1/tasks
create a task
DMAPICreateTask body → 201400
GET
/api/v1/tasks
get task list
DMAPIGetTaskList 3 params → 200400
GET
/api/v1/tasks/{task-name}
get a task
DMAPIGetTask 2 params → 200404
DELETE
/api/v1/tasks/{task-name}
delete a task
DMAPIDeleteTask 3 params → 204400
PUT
/api/v1/tasks/{task-name}
update a task
DMAPIUpdateTask 1 param body → 200400
GET
/api/v1/tasks/{task-name}/status
get task status
DMAPIGetTaskStatus 2 params → 200400
POST
/api/v1/tasks/{task-name}/start
start a task
DMAPIStartTask 1 param body → 200400
POST
/api/v1/tasks/{task-name}/stop
stop a task
DMAPIStopTask 1 param body → 200400
GET
/api/v1/tasks/{task-name}/sources/{source-name}/migrate_targets
get task source table and target table route relation
DMAPIGetTaskMigrateTargets 4 params → 200400
GET
/api/v1/tasks/{task-name}/sources/{source-name}/schemas
get task source schema list
DMAPIGetSchemaListByTaskAndSource 2 params → 200400
GET
/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}
get task source table list
DMAPIGetTableListByTaskAndSource 3 params → 200400
GET
/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}
get task source table structure
DMAPIGetTableStructure 4 params → 200400
PUT
/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}
operate task source table structure
DMAPIOperateTableStructure 4 params body → 200400
DELETE
/api/v1/tasks/{task-name}/sources/{source-name}/schemas/{schema-name}/{table-name}
delete task source table structure
DMAPIDeleteTableStructure 4 params → 204400
POST
/api/v1/tasks/converters
Turn task into the format of a configuration file or vice versa.
DMAPIConvertTask body → 201400
POST
/api/v1/tasks/templates
create task template
DMAPICreateTaskTemplate body → 201400
GET
/api/v1/tasks/templates
get task template list
DMAPIGetTaskTemplateList → 200400
POST
/api/v1/tasks/templates/import
import task template
DMAPIImportTaskTemplate body → 202400
GET
/api/v1/tasks/templates/{task-name}
get task template template
DMAPIGetTaskTemplate 1 param → 200400
PUT
/api/v1/tasks/templates/{task-name}
update task template template
DMAPUpdateTaskTemplate 1 param → 200400
DELETE
/api/v1/tasks/templates/{task-name}
delete task template template
DMAPIDeleteTaskTemplate 1 param → 204400

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are TaskFullMigrateConf (15 properties), SyncStatus (14 properties), Task (13 properties), SubTaskStatus (10 properties). Each schema is shown below with its type and property counts.

GetTaskListResponse
object
2 properties 2 required
UpdateTaskRequest
object
1 property 1 required
LoadStatus
object
status of load unit
6 properties 6 required
OperateTaskTableStructureRequest
object
action to operate table request
3 properties 1 required
TaskStage
string
TaskSourceConf
object
4 properties 1 required
ConverterTaskResponse
object
2 properties 2 required
SchemaNameList
array
schema name list
GetTaskTableStructureResponse
object
3 properties 2 required
StartTaskRequest
object
4 properties
TableNameList
array
schema name list
SyncStatus
object
status of sync unit
14 properties 14 required
SourceNameList
array
source name list
TaskFullMigrateConf
object
configuration of full migrate tasks
15 properties
TaskTemplateRequest
object
1 property 1 required
CreateTaskRequest
object
1 property 1 required
OperateTaskResponse
object
2 properties 2 required
DumpStatus
object
status of dump unit
7 properties 7 required
StopTaskRequest
object
2 properties
TaskMigrateTarget
object
task migrate targets
4 properties 4 required
ConverterTaskRequest
object
2 properties
TaskSourceConfig
object
source-related configuration
3 properties 1 required
TaskIncrMigrateConf
object
configuration of incremental tasks
2 properties
GetTaskStatusResponse
object
2 properties 2 required
TaskTemplateResponse
object
2 properties 2 required
TaskTargetDataBase
object
downstream database configuration
5 properties 4 required
TaskBinLogFilterRule
object
Filtering rules at binlog level
2 properties
TaskTableMigrateRuleSource
object
source-related configuration
3 properties 3 required
TaskTableMigrateRuleTarget
object
downstream-related configuration
2 properties
SubTaskStatus
object
10 properties 5 required
Task
object
task
13 properties 7 required
TaskTableMigrateRule
object
upstream table to downstream migrate rules
3 properties 1 required
ErrorWithMessage
object
operation error
2 properties 2 required
ShardingGroup
object
5 properties 5 required
Security
objectnull
data source ssl configuration, the field will be hidden when getting the data source configuration from the interface
4 properties 3 required
GetTaskMigrateTargetsResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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