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

tidb Integrations API

Operations for managing third-party integrations with TiDB Cloud clusters.

tidb Integrations API is one of 23 APIs that Tidb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Integration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version v1beta1.

Requests are made against 3 base URLs: https://dedicated.tidbapi.com/v1beta1, https://iam.tidbapi.com/v1beta1, https://billing.tidbapi.com/v1beta1.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1beta1
Base URL
https://api.tidbcloud.com
Authentication
HTTP Digest
Terms of Service
Resource Areas
1

Authentication & Security 1

tidb Integrations API declares 1 security scheme for authenticating requests. It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • digestAuth — HTTP Digest Authentication using a TiDB Cloud API public key as the username and private key as the password. Keys are generated in the TiDB Cloud console unde…

Paths & Operations 2

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

Integrations 2

Operations for managing third-party integrations with TiDB Cloud clusters.

GET
/clusters/{clusterId}/integrations
List integrations
listIntegrations 1 param → 200401404
POST
/clusters/{clusterId}/integrations
Create an integration
createIntegration 1 param body → 200400401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (4 properties), Integration (3 properties), CreateIntegrationRequest (2 properties), ListIntegrationsResponse (1 property). Each schema is shown below with its type and property counts.

Integration
object
A third-party monitoring or observability integration for a cluster.
3 properties
CreateIntegrationRequest
object
Request body for creating a new cluster integration.
2 properties 1 required
ErrorResponse
object
Standard error response returned when an API request fails.
4 properties
ListIntegrationsResponse
object
List of integrations for a cluster.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tidb-integrations-api-openapi.yml Raw ↑

Other APIs Tidb publishes across the network.

tidb API Keys API
tidb Audit Logs API
tidb Billing API
tidb Chat2Data API
tidb Clusters API
tidb Data App API Keys API
tidb Data Apps API
tidb Data Sources API
tidb Data Summaries API
tidb DDL API
tidb Deployments API
tidb Diagnostics API
Where this information came from

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