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 Endpoint API

Create, get, delete, list, and test endpoints of a Data App.

PingCAP Endpoint API is one of 32 APIs that PingCAP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version v1beta1.

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

6 operations 3 paths 16 schemas 1 DELETE2 GET1 PATCH2 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 6

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

Endpoint 6

Create, get, delete, list, and test endpoints of a Data App.

GET
/v1beta1/dataApps/{dataAppId}/endpoints
List all endpoints in a Data App.
Endpoint_ListEndpoints 3 params → 200400
POST
/v1beta1/dataApps/{dataAppId}/endpoints
Create an endpoint for a Data App.
Endpoint_CreateEndpoint 1 param body → 200400
PATCH
/v1beta1/dataApps/{endpoint.name}
Update an endpoint for a Data App.
Endpoint_UpdateEndpoint 1 param body → 200400
GET
/v1beta1/dataApps/{endpoint.name}
Get an endpoint for a Data App.
Endpoint_GetEndpoint 1 param → 200400
DELETE
/v1beta1/dataApps/{endpoint.name}
Delete an endpoint for a Data App.
Endpoint_DeleteEndpoint 1 param → 200400
POST
/v1beta1/{endpoint.name}/test
Test an endpoint for a Data App.
Endpoint_TestEndpoint 1 param body → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are v1beta1EndpointRes (16 properties), v1beta1Endpoint (10 properties), TestEndpointResponseResult (8 properties), v1beta1EndpointParamsRes (7 properties). Each schema is shown below with its type and property counts.

v1beta1EndpointSettings
object
The settings used in the endpoint.
5 properties 5 required
TestEndpointResponseRow
object
1 property
protobufAny
object
1 property
TestEndpointResponseResult
object
Return basic information about request execution. For example: whether the execution is successful, execution time, number of items returned, etc.
8 properties
TestEndpointResponseColumn
object
3 properties
v1beta1EndpointParamsRes
object
7 properties
v1beta1ListEndpointsResponse
object
2 properties
rpcStatus
object
3 properties
v1beta1EndpointParamsType
string
The user-defined data type of the parameter. - string - number - integer - bool - array
v1beta1EndpointParams
object
7 properties 2 required
v1beta1EndpointArgs
object
1 property 1 required
v1beta1EndpointRes
object
16 properties
v1beta1TestEndpointResponse
object
2 properties
v1beta1Endpoint
object
10 properties 7 required
v1beta1EndpointSettingsRes
object
The settings used in the endpoint.
5 properties
TestEndpointResponseData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-endpoint-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 App API
Where this information came from

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