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

PingCAP Data App API

Create, get, update, delete, and list Data Apps.

PingCAP Data App 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 App. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 4 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.

9 operations 4 paths 9 schemas 1 DELETE4 GET3 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 9

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

Data App 9

Create, get, update, delete, and list Data Apps.

GET
/v1beta1/dataApps
List all Data Apps in a project.
DataApp_ListDataApps 3 params → 200400
POST
/v1beta1/dataApps
Create a Data App.
DataApp_CreateDataApp body → 200400
GET
/v1beta1/dataApps/{dataAppId}/systemEndpointConfig
List all system endpoints in a Data App.
DataAppsService_GetSystemEndpointConfig 1 param → 200400
PATCH
/v1beta1/dataApps/{dataAppId}/systemEndpointConfig
Update the configuration of system endpoints.
DataAppsService_UpdateSystemEndpointConfig 1 param body → 200400
GET
/v1beta1/dataApps/{dataAppId}/chat2querySettings
Get Chat2Query Data App settings by ID.
DataApp_GetChat2QuerySettings 1 param → 200400
PATCH
/v1beta1/dataApps/{dataAppId}/chat2querySettings
Update Chat2Query Data App settings by ID.
DataApp_UpdateChat2QuerySettings 1 param body → 200400
PATCH
/v1beta1/dataApps/{dataAppId}
Update a Data App.
DataApp_UpdateDataApp 1 param body → 200400
GET
/v1beta1/dataApps/{dataAppId}
Get a Data App by ID.
DataApp_GetDataApp 1 param → 200400
DELETE
/v1beta1/dataApps/{dataAppId}
Delete a Data App.
DataApp_DeleteDataApp 1 param → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are v1beta1DataApp (10 properties), v1beta1DataAppRes (10 properties), v1beta1Chat2QuerySettingsRes (4 properties), v1beta1SystemEndpointConfigItem (3 properties). Each schema is shown below with its type and property counts.

v1beta1Chat2QuerySettingsRes
object
4 properties 3 required
v1beta1SystemEndpointConfigItem
object
3 properties 3 required
protobufAny
object
1 property
v1beta1DataAppType
string
The type of the Data App. - DATAAPP: standard Data APP - CHAT2QUERY: Chat2Query Data App
v1beta1ListDataAppsResponse
object
2 properties
v1beta1DataAppRes
object
10 properties
rpcStatus
object
3 properties
v1beta1SystemEndpointConfigRes
object
2 properties 1 required
v1beta1DataApp
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-data-app-api-openapi.yml Raw ↑

Other APIs PingCAP publishes across the network.

TiDB MCP Server
PingCAP API Key API
PingCAP Audit Log API
PingCAP Backup API
PingCAP Billing API
PingCAP Branch API
PingCAP Changefeed API
PingCAP Chat2 Query API
PingCAP Cluster API
PingCAP Collections API
PingCAP Data API Key API
PingCAP Data Source API
Where this information came from

This is an independent, third-party profile of PingCAP Data App 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.