Vitess

Vitess VTAdmin API

VTAdmin is the administrative web application and REST API for managing Vitess clusters. It provides endpoints for inspecting cluster topology, tablets, keyspaces, shards, schemas, and VReplication workflows, and serves as the backend for the VTAdmin web UI.

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vtadmin-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Vitess VTAdmin API
  description: >-
    VTAdmin is the administrative REST API and web application for managing
    Vitess clusters. It provides endpoints for inspecting and managing cluster
    topology, tablets, keyspaces, shards, schemas, and VReplication workflows.
    VTAdmin serves as the backend for the VTAdmin web UI and enables programmatic
    administration of multi-cluster Vitess deployments. The API supports operations
    such as tablet health inspection, schema management, vschema management, query
    execution, backup management, and workflow orchestration across one or more
    named Vitess clusters.
  version: '19.0'
  contact:
    name: Vitess Community
    url: https://vitess.io/community/
  termsOfService: https://github.com/vitessio/vitess/blob/main/LICENSE
externalDocs:
  description: VTAdmin API Documentation
  url: https://vitess.io/docs/reference/vtadmin/
servers:
  - url: http://{host}:{port}/api
    description: VTAdmin Server
    variables:
      host:
        default: localhost
      port:
        default: '14200'
tags:
  - name: Clusters
    description: Operations for listing and inspecting Vitess clusters registered with VTAdmin
  - name: Tablets
    description: Operations for managing VTTablet instances across clusters
  - name: Keyspaces
    description: Operations for managing keyspaces within Vitess clusters
  - name: Shards
    description: Operations for managing shards within keyspaces
  - name: Schema
    description: Operations for inspecting and managing database schemas
  - name: VSchema
    description: Operations for managing VTGate routing schemas (VSchemas)
  - name: Workflows
    description: Operations for managing VReplication workflows
  - name: Backups
    description: Operations for managing tablet backups
  - name: Cells
    description: Operations for listing cells within clusters
  - name: Gates
    description: Operations for managing VTGate instances
  - name: Topology
    description: Operations for inspecting cluster topology
security:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vitess/refs/heads/main/openapi/vitess-vtadmin-openapi.yml