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 Data API Key API

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v1beta1.

Requests are made against a single base URL, https://dataservice.tidbapi.com.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 5

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

Data API Key 5

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…

GET
/v1beta1/dataApps/{dataAppId}/apiKeys
List all API keys for a Data App.
APIKey_ListApiKeys 3 params → 200400
POST
/v1beta1/dataApps/{dataAppId}/apiKeys
Create an API key for a Data App.
APIKey_CreateApiKey 1 param body → 200400
PATCH
/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}
Update an API key for a Data App.
APIKey_UpdateApiKey 2 params body → 200default
GET
/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}
Get an API key by ID.
APIKey_GetApiKey 2 params → 200400
DELETE
/v1beta1/dataApps/{dataAppId}/apiKeys/{apiKeyId}
Delete an API key for a Data App.
APIKey_DeleteApiKey 2 params → 200400

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are v1beta1ApiKeyRes (10 properties), v1beta1ApiKey (4 properties), rpcStatus (3 properties), v1beta1ListApiKeysResponse (2 properties). Each schema is shown below with its type and property counts.

ApiKeyRole
string
Controls whether the API key can read or write data to the clusters linked to the Data App. - READANDWRITE: allows the API key to read and write data. You can…
v1beta1ListApiKeysResponse
object
2 properties
protobufAny
object
1 property
ApiKeyExpireOption
string
The method used to determine the API key's expiration: - EXPIREOPTIONNEVEREXPIRE: this key will never expire - EXPIREOPTIONSETTTL: this key will expire after t…
v1beta1ApiKey
object
An API key of a Data App.
4 properties 3 required
v1beta1ApiKeyRes
object
An API key of a Data App
10 properties
ApiKeyApiKeyExpireSetting
object
The expiration settings for the API key.
2 properties
rpcStatus
object
3 properties
ApiKeyExpireState
string
The expiration state of the API key: - EXPIRESTATENEVEREXPIRE: this API key never expires - EXPIRESTATEEXPIRED: this API key has expired - EXPIRESTATENOTEXPIRE…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-data-api-key-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 App API
AE Profile APIs.io
PingCAP Data Source API
AE Profile APIs.io
#Data API Key
← Back to P APIs
API Details
ID
pingcap:pingcap-data-api-key-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-data-api-key-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pingcap-data-api-key-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 Data API Key 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.