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

source

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 11 paths, and defines 19 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/.

14 operations 11 paths 19 schemas 1 DELETE5 GET7 POST1 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 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 5 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

source 14

source

POST
/api/v1/sources
create and enable a new data source
DMAPICreateSource body → 201400
GET
/api/v1/sources
get data source list
DMAPIGetSourceList 2 params → 200
GET
/api/v1/sources/{source-name}
get source
DMAPIGetSource 2 params → 200404
DELETE
/api/v1/sources/{source-name}
delete a data source
DMAPIDeleteSource 2 params → 204400
PUT
/api/v1/sources/{source-name}
update a data source
DMAPIUpdateSource 1 param body → 200400
GET
/api/v1/sources/{source-name}/status
get the current status of the data source
DMAPIGetSourceStatus 1 param → 200400
POST
/api/v1/sources/{source-name}/enable
enable a data source
DMAPIEnableSource 1 param → 200400
POST
/api/v1/sources/{source-name}/disable
disable a data source
DMAPIDisableSource 1 param → 200400
POST
/api/v1/sources/{source-name}/transfer
transfer source to a free worker
DMAPITransferSource 1 param body → 200400
POST
/api/v1/sources/{source-name}/relay/enable
enable relay log function for the data source
DMAPIEnableRelay 1 param body → 200400
POST
/api/v1/sources/{source-name}/relay/disable
disable relay log function for the data source
DMAPIDisableRelay 1 param body → 200400
POST
/api/v1/sources/{source-name}/relay/purge
purge relay log
DMAPIPurgeRelay 1 param body → 200400
GET
/api/v1/sources/{source-name}/schemas
get source schema list
DMAPIGetSourceSchemaList 1 param → 200400
GET
/api/v1/sources/{source-name}/schemas/{schema-name}
get source table list
DMAPIGetSourceTableList 2 params → 200400

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Source (13 properties), RelayStatus (6 properties), EnableRelayRequest (4 properties), Security (4 properties). Each schema is shown below with its type and property counts.

Security
objectnull
data source ssl configuration, the field will be hidden when getting the data source configuration from the interface
4 properties 3 required
SchemaNameList
array
schema name list
PurgeRelayRequest
object
action to stop a relay request
2 properties 1 required
Purge
object
relay log cleanup policy configuration
3 properties
DisableRelayRequest
object
action to stop a relay request
1 property
TableNameList
array
schema name list
RelayConfig
object
the config of relay
4 properties
EnableRelayRequest
object
action to start a relay request
4 properties
RelayStatus
object
status of relay log
6 properties 6 required
GetSourceListResponse
object
2 properties 2 required
UpdateSourceRequest
object
1 property 1 required
WorkerNameRequest
object
requests related to workers
1 property 1 required
WorkerNameList
array
worker name list
TaskNameList
array
task name list
GetSourceStatusResponse
object
2 properties 2 required
SourceStatus
object
source status
4 properties 2 required
ErrorWithMessage
object
operation error
2 properties 2 required
Source
object
source
13 properties 6 required
CreateSourceRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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