skills.rest
alex-quan-001
alex-quan-001COMMUNITY
Explore all skills by this author →
GitHub

tidbcloud-api

Automates TiDB Cloud cluster management via REST API calls.

Updated Jun 3, 2026
Search Tags:#devops#database#api#cloud-infrastructure#cluster-management#rest-api#tidbcloud
One-click install
npx skills add https://github.com/alex-quan-001/nutshell-skills --skill tidbcloud-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tidbcloud-api
Source: https://github.com/alex-quan-001/nutshell-skills/tree/main/skills/platform/tidbcloud-api
Command: npx skills add https://github.com/alex-quan-001/nutshell-skills --skill tidbcloud-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, curl, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Manually managing TiDB Cloud clusters via the web console is time-consuming and error-prone, especially for repetitive tasks like provisioning test environments or running bulk SQL operations. This Skill eliminates that overhead by providing secure, scripted access to the TiDB Cloud REST API.

Core Features & Use Cases

  • Multi-Tier Cluster Management: Create, delete, list, and update Starter, Essential, and Premium TiDB Cloud clusters via API calls, with optimized fast paths for common create and delete operations.
  • Secure Credential Handling: All API authentication uses HTTP digest auth, with credentials loaded from environment variables or local files and never exposed to the agent context.
  • Flexible Operation Support: Execute any TiDB Cloud API operation via the OpenAPI selector, including CMEK encryption setup for Premium clusters and SQL query execution against provisioned databases.
  • Use Case: A platform engineer can use this Skill to spin up 5 identical Premium test clusters with CMEK encryption in 2 minutes, instead of manually configuring each one via the console.

Quick Start

Use the tidbcloud-api skill to create a new TiDB Cloud Starter cluster named 'test-cluster' in the us-east-1 region and wait for it to reach an active state.

Frequently Asked Questions about tidbcloud-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate TiDB Cloud cluster provisioning for multiple test environments?▼

You can automate TiDB Cloud cluster provisioning by using REST API calls to create, update, and delete Starter, Essential, or Premium clusters. This scripted approach eliminates manual web console configuration and rapidly deploys identical test environments.

Do I need curl and jq to manage TiDB Cloud clusters via API?▼

Yes, you need curl and jq to manage TiDB Cloud clusters via API. The Skill uses curl to construct and execute HTTP requests with digest authentication, while jq parses the JSON responses, including polling cluster readiness states.

Can I run SQL queries against a TiDB Cloud database through an API call?▼

Yes, you can execute SQL queries against provisioned TiDB Cloud databases through the flexible operation support. The Skill leverages an OpenAPI selector to run arbitrary operations, enabling direct SQL execution without needing the web console.

How does this approach handle TiDB Cloud API credentials securely?▼

This approach handles TiDB Cloud API credentials securely by using HTTP digest authentication loaded directly from environment variables or local files. Credentials are processed within the scripts and never exposed to the agent context.

What is the best way to configure CMEK encryption for Premium TiDB Cloud clusters?▼

The best way to configure CMEK encryption for Premium TiDB Cloud clusters is through the OpenAPI selector. It constructs the necessary REST API requests to apply encryption settings during or after automated cluster provisioning.

Can I use this Skill to delete TiDB Cloud clusters and verify their removal?▼

Yes, you can use this Skill to delete TiDB Cloud clusters via optimized API fast paths. It constructs the deletion request and handles response polling to verify that the cluster removal process reaches completion.

Related Skills

Explore More Software Engineering Skills→
0xHoneyJar0xHoneyJar
1

loa-credentials

Manage API credentials across environment variables, encrypted stores, and dotenv files.

Official
Intermediate
ajmeyers42ajmeyers42
1

warp-scan

Parse Elastic diagnostic files to produce a structured current-state profile.

Community
Advanced
cockroachdbcockroachdb
3

enabling-cmek-encryption

Enable CMEK encryption on CockroachDB Cloud clusters with AWS KMS, GCP Cloud KMS, or Azure Key Vault.

Official
Advanced
miketrombamiketromba
2

hetzner-cloud

Manage Hetzner Cloud servers, networks, storage, and DNS via API.

Community
Advanced