Skip to main content

Connect TiDB Cloud

1 auth method · updated 2026-09-10

Manage TiDB Cloud Starter, Essential, Dedicated, IAM, billing, and Data Service control-plane resources.

tidbcloud.com/ ↗

API key

Uses your own credential — Verslay stores it encrypted

Connectable today
  1. 1
    Sign in to TiDB Cloud
    Open https://tidbcloud.com/ and sign in to the account you want to connect.
  2. 2
    Create the API key
    Open https://docs.pingcap.com/tidbcloud/api-overview/ and generate a new API key.
  3. 3
    Copy it immediately
    TiDB Cloud usually shows the full API key only once, right after you create it. Store it somewhere safe before closing the page.
  4. 4
    Connect in Verslay
    In the Verslay Hub, open Connections, find TiDB Cloud, and paste the API key into the Public Key, Private Key field.
  5. 5
    Verify
    The connection flips to Connected. Run any read-only action once to confirm the credential has the right scopes.
  6. 6
    Rotate safely
    When you rotate later: connect the new credential first, confirm it works, then revoke the old one.

What you’ll paste into Verslay

Public Key

The public key from your TiDB Cloud organization API key. In the TiDB Cloud console, switch to the target organization, then open Organization Settings > API Keys and create or select an API key. This value is the HTTP Digest username.

required · secret
Private Key

The private key shown when you create the TiDB Cloud organization API key under Organization Settings > API Keys. TiDB Cloud displays it only once. This secret is the HTTP Digest password.

required · secret
Get your credential ↗TiDB Cloud website ↗

Connect TiDB Cloud once — every agent can use it

Verslay agents share your connections. Connect TiDB Cloud in the Hub and every use-case that needs it lights up — no per-agent setup.

Open the Hub →
← All connection guides