# TiDB Cloud Data Service API

**Canonical:** https://apis.io/apis/tidb/tidb-cloud-data-service-api/  
**Provider:** Tidb — https://apis.io/providers/tidb/  
**Base URL:** https://dataservice.tidbapi.com  
**Documentation:** https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/

TiDB Cloud Data Service API is one of 31 APIs that [Tidb](https://apis.io/providers/tidb/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Data App, DataSource, Deployment, Data API Key, and OpenAPI Specification. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

The published Swagger 2.0 contract for TiDB Cloud Data Service — create Data Apps, link clusters as data sources, define and test custom REST endpoints backed by SQL templates, deploy them, manage their API keys, and retrieve the generated OpenAPI specification for the resulting app. 28 operations, harvested verbatim from PingCAP.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1beta1/dataApps` | List all Data Apps in a project. |
| POST | `/v1beta1/dataApps` | Create a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/systemEndpointConfig` | List all system endpoints in a Data App. |
| PATCH | `/v1beta1/dataApps/{dataAppId}/systemEndpointConfig` | Update the configuration of system endpoints. |
| GET | `/v1beta1/dataApps/{dataAppId}/chat2querySettings` | Get Chat2Query Data App settings by ID. |
| PATCH | `/v1beta1/dataApps/{dataAppId}/chat2querySettings` | Update Chat2Query Data App settings by ID. |
| PATCH | `/v1beta1/dataApps/{dataAppId}` | Update a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}` | Get a Data App by ID. |
| DELETE | `/v1beta1/dataApps/{dataAppId}` | Delete a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/dataSources` | List all data sources in a Data App. |
| POST | `/v1beta1/dataApps/{dataAppId}/dataSources` | Create a data source for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/dataSources/{clusterId}` | Get a data source by ID. |
| DELETE | `/v1beta1/dataApps/{dataAppId}/dataSources/{clusterId}` | Delete a data source for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/endpoints` | List all endpoints in a Data App. |
| POST | `/v1beta1/dataApps/{dataAppId}/endpoints` | Create an endpoint for a Data App. |
| PATCH | `/v1beta1/dataApps/{endpoint.name}` | Update an endpoint for a Data App. |
| GET | `/v1beta1/dataApps/{endpoint.name}` | Get an endpoint for a Data App. |
| DELETE | `/v1beta1/dataApps/{endpoint.name}` | Delete an endpoint for a Data App. |
| POST | `/v1beta1/{endpoint.name}/test` | Test an endpoint for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/apiKeys` | List all API keys for a Data App. |
| POST | `/v1beta1/dataApps/{dataAppId}/apiKeys` | Create an API key for a Data App. |
| PATCH | `/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}` | Update an API key for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}` | Get an API key by ID. |
| DELETE | `/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}` | Delete an API key for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/deployments` | List all deployments for a Data App. |
| POST | `/v1beta1/dataApps/{dataAppId}/deployments` | Create a deployment for a Data App. |
| GET | `/v1beta1/dataApps/{dataAppId}/deployments/{deploymentId}` | Get a deployment by ID. |
| GET | `/v1beta1/dataApps/{dataAppId}/apiSpec` | Get the OpenAPI Specification of a Data App. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/openapi/_original/tidb-cloud-dataservice-v1beta1-openapi-original.json
- **OpenAPI** — https://docs-download.pingcap.com/api/tidbcloud-oas-v1beta1-dataservice.swagger.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/overlays/tidb-dataservice-overlay.yaml
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api-overview/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/authentication/tidb-authentication.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/rate-limits/tidb-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/errors/tidb-problem-types.yml

## Other Tidb APIs (12)

- [tidb API Keys API](https://apis.io/apis/tidb/tidb-api-keys-api/)
- [tidb Audit Logs API](https://apis.io/apis/tidb/tidb-audit-logs-api/)
- [tidb Billing API](https://apis.io/apis/tidb/tidb-billing-api/)
- [tidb Chat2Data API](https://apis.io/apis/tidb/tidb-chat2data-api/)
- [tidb Clusters API](https://apis.io/apis/tidb/tidb-clusters-api/)
- [tidb Data App API Keys API](https://apis.io/apis/tidb/tidb-data-app-api-keys-api/)
- [tidb Data Apps API](https://apis.io/apis/tidb/tidb-data-apps-api/)
- [tidb Data Sources API](https://apis.io/apis/tidb/tidb-data-sources-api/)
- [tidb Data Summaries API](https://apis.io/apis/tidb/tidb-data-summaries-api/)
- [tidb DDL API](https://apis.io/apis/tidb/tidb-ddl-api/)
- [tidb Deployments API](https://apis.io/apis/tidb/tidb-deployments-api/)
- [tidb Diagnostics API](https://apis.io/apis/tidb/tidb-diagnostics-api/)

## Tags

Data App, DataSource, Deployment, Data API Key, OpenAPI Specification

---

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