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

Get private link service for a TiDB node group, create a private endpoint connection, list private endpoint connections, get a private endpoint connection, and delete a private endpoint connection.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Private Endpoint Connection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

5 operations 3 paths 8 schemas 1 DELETE3 GET1 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 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Private Endpoint Connection 5

Get private link service for a TiDB node group, create a private endpoint connection, list private endpoint connections, get a private endpoint connection, and delete a private en…

GET
/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateLinkService
Get private link service for a TiDB node group
PrivateEndpointConnectionService_GetPrivateLinkService 2 params → 200400401403429500default
GET
/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections
List private endpoint connections
PrivateEndpointConnectionService_ListPrivateEndpointConnections 7 params → 200400401403429500default
POST
/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections
Create a private endpoint connection
PrivateEndpointConnectionService_CreatePrivateEndpointConnection 3 params body → 200400401403429500default
GET
/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId}
Get a private endpoint connection
PrivateEndpointConnectionService_GetPrivateEndpointConnection 3 params → 200400401403429500default
DELETE
/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId}
Delete a private endpoint connection
PrivateEndpointConnectionService_DeletePrivateEndpointConnection 3 params → 200400401403429500default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are dedicatedv1beta1PrivateEndpointConnection (19 properties), dedicatedv1beta1PrivateLinkService (9 properties), dedicatedv1beta1ListPrivateEndpointConnectionsResponse (3 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.

dedicatedv1beta1PrivateEndpointConnection
object
19 properties 2 required
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
googlerpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
dedicatedv1beta1PrivateLinkServiceState
string
- CREATING: The private link service is being created. - ACTIVE: The private link service is active and ready for use. - DELETING: The private link service is…
dedicatedv1beta1ListPrivateEndpointConnectionsResponse
object
3 properties
v1beta1RegionCloudProvider
string
Enum of cloud provider names. - aws: Amazon Web Services. - gcp: Google Cloud Platform. - azure: Microsoft Azure. - alicloud: Alibaba Cloud.
dedicatedv1beta1PrivateEndpointConnectionEndpointState
string
The state of the private endpoint connection. - "PENDING": TiDB Cloud is asynchronously accepting the endpoint connection. - "ACTIVE": the private endpoint con…
dedicatedv1beta1PrivateLinkService
object
All fields are output only.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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