# PingCAP Source API

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

source

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/sources` | create and enable a new data source |
| GET | `/api/v1/sources` | get data source list |
| GET | `/api/v1/sources/{source-name}` | get source |
| DELETE | `/api/v1/sources/{source-name}` | delete a data source |
| PUT | `/api/v1/sources/{source-name}` | update a data source |
| GET | `/api/v1/sources/{source-name}/status` | get the current status of the data source |
| POST | `/api/v1/sources/{source-name}/enable` | enable a data source |
| POST | `/api/v1/sources/{source-name}/disable` | disable a data source |
| POST | `/api/v1/sources/{source-name}/transfer` | transfer source to a free worker |
| POST | `/api/v1/sources/{source-name}/relay/enable` | enable relay log function for the data source |
| POST | `/api/v1/sources/{source-name}/relay/disable` | disable relay log function for the data source |
| POST | `/api/v1/sources/{source-name}/relay/purge` | purge relay log |
| GET | `/api/v1/sources/{source-name}/schemas` | get source schema list |
| GET | `/api/v1/sources/{source-name}/schemas/{schema-name}` | get source table list |

## Machine-readable artifacts (19)

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

Source

---

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