# PingCAP Data API Key API

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

Create, get, update, delete, and list Data API keys of a Data App. The Data API key in Data Service is different from the key used in the [TiDB Cloud API](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication). The Data API key is used to access data in the TiDB Cloud clusters, whereas the TiDB Cloud API key is used to manage resources such as projects, clusters, Data Apps, and endpoints.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| 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. |

## Machine-readable artifacts (19)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-data-api-key-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 App API](https://apis.io/apis/pingcap/pingcap-data-app-api/)
- [PingCAP Data Source API](https://apis.io/apis/pingcap/pingcap-data-source-api/)

## Tags

Data API Key

---

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