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
Yugabyte

Yugabyte cluster-info API

APIs for getting information about an existing cluster

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte cluster-info API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include cluster-info. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 15 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, {protocol}://{host_port}/api.

15 operations 15 paths 45 schemas 15 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Contact
Yugabyte Cloud Support
License
Properietary (TBD)
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Yugabyte cluster-info API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthToken). By default, every request must be authenticated.

Paths & Operations 15

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

cluster-info 15

APIs for getting information about an existing cluster

GET
/live_queries
Get the live queries in a cluster
getLiveQueries 1 param → 200400500
GET
/slow_queries
Get the slow queries in a cluster
getSlowQueries → 200400500
GET
/nodes
Get the nodes for a cluster
getClusterNodes 1 param → 200400500
GET
/metrics
Get a metric for a cluster
getClusterMetric 7 params → 200400500
GET
/activities
Get a activities data for a cluster
getClusterActivities 3 params → 200400500
GET
/tables
Get list of DB tables per YB API (YCQL/YSQL)
getClusterTables 1 param → 200400500
GET
/table
Get info on a single table, given table uuid
getTableInfo 2 params → 200400500
GET
/health-check
Get health information about the cluster
getClusterHealthCheck → 200400500
GET
/tablets
Get list of tablets
getClusterTablets → 200400500
GET
/version
Get YugabyteDB version
getVersion → 200400500
GET
/is_load_balancer_idle
Check if cluster load balancer is idle
getIsLoadBalancerIdle → 200400500
GET
/gflags
Get gflags of master and tserver process
getGflags 1 param → 200400500
GET
/alerts
Get any alerts for the cluster
getClusterAlerts 1 param → 200400500
GET
/connections
Get YSQL connection manager stats for every node of the cluster
getClusterConnections → 200400500
GET
/node_address
Get the node address for the current node
getNodeAddress → 200400500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are NodeData_metrics (16 properties), SlowQueryResponseYSQLQueryItem (13 properties), NodeData (12 properties), ConnectionStatsItem (10 properties). Each schema is shown below with its type and property counts.

TabletInfo
object
Tablet Info
7 properties
Cluster_table_list_response
object
2 properties 2 required
LiveQueryResponseYSQLData
object
Schema for Live Query Response YSQL Data
2 properties
LiveQueryResponseSchema
object
Live Query Response Schema
1 property
Gflag
object
Gflag
3 properties
ApiError_error
object
2 properties
Health_Check_Response
object
1 property
ConnectionStats
array
GflagsInfo
object
Gflags Info
2 properties 2 required
ActivityData
object
Activity Data
2 properties 2 required
ClusterTable
object
Model representing a DB table
5 properties 5 required
SlowQueryResponseSchema
object
Slow Query Response Schema
1 property
SlowQueryResponseYSQLData
object
Schema for Slow Query Response YSQL Data
2 properties
NodeData_metrics
object
16 properties 16 required
NodeData_cloud_info
object
3 properties 2 required
Alerts_Response
object
1 property 1 required
TableInfo
object
Table Info
10 properties 9 required
Cluster_tablet_list_response
object
1 property 1 required
NodeData_metrics_active_connections
object
2 properties 2 required
ConnectionStatsItem
object
10 properties 8 required
LiveQueryResponseData
object
Live Query Response Data
2 properties
RaftConfig
object
Raft Config
3 properties
LiveQueryResponseYCQLData
object
Schema for Live Query Response YCQL Data
2 properties
YbApiEnum
string
Type of DB API (YSQL/YCQL)
Is_load_balancer_idle
object
Is load balancer idle
1 property 1 required
Cluster_Nodes_Response
object
1 property 1 required
ApiError
object
1 property
TableReplicationInfo
object
TableReplicationInfo
3 properties
TableInfo_table_replication_info
object
2 properties
VersionInfo
object
YugabyteDB version info
1 property
Activities_Response
object
1 property 1 required
ColumnInfo
object
Column Info
3 properties
AlertsInfo
object
Alerts Info
2 properties 2 required
Metric_Response
object
3 properties 3 required
MetricData
object
Metric data
2 properties 2 required
LiveQueryResponseYCQLQueryItem
object
Schema for Live Query Response YCQL Query Item
8 properties
LiveQueryResponseYSQLQueryItem
object
Schema for Live Query Response YSQL Query Item
10 properties
PlacementBlock
object
Placement Block
2 properties
SlowQueryResponseYSQLQueryItem
object
Schema for Slow Query Response YSQL Query Item
13 properties
SlowQueryResponseData
object
Slow Query Response Data
1 property
NodeData
object
Node data
12 properties 11 required
HealthCheckInfo
object
4 properties 4 required
ConnectionsStats
object
YSQL connection manager stats
1 property
PlacementCloudInfo
object
Placement Cloud Info
3 properties
ClusterTablet
object
Model representing a tablet
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-cluster-info-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
AE Profile APIs.io
Yugabyte backup-info API
AE Profile APIs.io
Yugabyte cluster API
AE Profile APIs.io
Yugabyte pitr-info API
AE Profile APIs.io
Yugabyte restore-info API
AE Profile APIs.io
Yugabyte voyager-info API
AE Profile APIs.io
Yugabyte voyager-metrics API
AE Profile APIs.io
Yugabyte Xcluster Metrics API
AE Profile APIs.io
Yugabyte Xcluster Namespace Details API
AE Profile APIs.io
#cluster-info
← Back to Y APIs
API Details
ID
yugabyte:yugabyte-cluster-info-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://api-docs.yugabyte.com/docs/managed-apis/9u5yqnccbe8lk-yugabyte-db-aeon-rest-api
Provider
Yugabyte
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=yugabyte-cluster-info-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabyte-cluster-info-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 Yugabyte cluster-info 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.