Yugabyte cluster-info API
APIs for getting information about an existing cluster
APIs for getting information about an existing cluster
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/yugabyte-cluster-info-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: support@yugabyte.com
name: Yugabyte Cloud Support
url: https://support.yugabyte.com/
description: YugabyteDB as a Service
license:
name: Properietary (TBD)
url: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
termsOfService: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
title: Yugabyte Cloud backup-info Cluster Info API
version: v1
servers:
- description: Endpoint of the API server
url: '{protocol}://{host_port}/api'
variables:
protocol:
default: http
enum:
- http
- https
host_port:
default: localhost:1323
security:
- BearerAuthToken: []
tags:
- description: APIs for getting information about an existing cluster
name: cluster-info
paths:
/live_queries:
get:
description: Get the Live Queries in a Yugabyte Cluster
operationId: getLiveQueries
parameters:
- description: type of queries for which to retrieve Live Queries (YSQL or YCQL)
explode: false
in: query
name: api
required: false
schema:
enum:
- YSQL
- YCQL
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LiveQueryResponseSchema'
description: Live Queries of a Cluster
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the live queries in a cluster
tags:
- cluster-info
/slow_queries:
get:
description: Get the Slow Queries in a Yugabyte Cluster
operationId: getSlowQueries
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SlowQueryResponseSchema'
description: Slow Queries of a Cluster
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the slow queries in a cluster
tags:
- cluster-info
/nodes:
get:
description: Get nodes for a Yugabyte cluster
operationId: getClusterNodes
parameters:
- allowEmptyValue: true
description: Whether to get master-only nodes that have no tserver
explode: true
in: query
name: get_all_masters
required: false
schema:
type: boolean
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster_Nodes_Response'
description: Cluster nodes response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the nodes for a cluster
tags:
- cluster-info
/metrics:
get:
description: Get metrics for a Yugabyte cluster
operationId: getClusterMetric
parameters:
- description: Which metrics to retrieve results for
explode: false
in: query
name: metrics
required: true
schema:
type: string
style: form
- description: Node name within the cluster
explode: false
in: query
name: node_name
required: false
schema:
type: string
style: form
- description: Region name to filter for the given cluster
explode: false
in: query
name: region
required: false
schema:
type: string
style: form
- description: Zone to filter for the given cluster
explode: false
in: query
name: zone
required: false
schema:
type: string
style: form
- description: Start of range of time series data (in epoch seconds)
explode: false
in: query
name: start_time
required: false
schema:
format: int64
minimum: 0
type: integer
style: form
- description: End of range of time series data (in epoch seconds)
explode: false
in: query
name: end_time
required: false
schema:
format: int64
minimum: 0
type: integer
style: form
- description: Cluster type (primary or read replica)
explode: false
in: query
name: cluster_type
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Metric_Response'
description: Metric response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get a metric for a cluster
tags:
- cluster-info
/activities:
get:
description: Get activities data for a Yugabyte cluster
operationId: getClusterActivities
parameters:
- description: Which activities data to retrieve
explode: false
in: query
name: activities
required: true
schema:
type: string
style: form
- description: Completed or In-Progress
explode: false
in: query
name: status
required: true
schema:
type: string
style: form
- description: Which database's activities data is to be retrived.
explode: false
in: query
name: database
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Activities_Response'
description: Activities Response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get a activities data for a cluster
tags:
- cluster-info
/tables:
get:
description: Get list of tables per YB API (YCQL/YSQL)
operationId: getClusterTables
parameters:
- description: Which DB API to get tables for (YCQL/YSQL)
explode: false
in: query
name: api
required: false
schema:
enum:
- YCQL
- YSQL
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster_table_list_response'
description: List of cluster tables
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get list of DB tables per YB API (YCQL/YSQL)
tags:
- cluster-info
/table:
get:
description: Get info on a single table, given table uuid
operationId: getTableInfo
parameters:
- description: UUID of the table
explode: false
in: query
name: id
required: true
schema:
type: string
style: form
- description: Specify the node ip-address from where the table info is retrieved
explode: false
in: query
name: node_address
required: true
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TableInfo'
description: Information for a single table
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get info on a single table, given table uuid
tags:
- cluster-info
/health-check:
get:
description: Get health information about the cluster
operationId: getClusterHealthCheck
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Health_Check_Response'
description: Successful health check response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get health information about the cluster
tags:
- cluster-info
/tablets:
get:
description: Get list of tablets
operationId: getClusterTablets
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Cluster_tablet_list_response'
description: List of cluster tablets
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get list of tablets
tags:
- cluster-info
/version:
get:
description: Get YugabyteDB version
operationId: getVersion
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VersionInfo'
description: Version info for YugabyteDB
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get YugabyteDB version
tags:
- cluster-info
/is_load_balancer_idle:
get:
description: Check if cluster load balancer is idle
operationId: getIsLoadBalancerIdle
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Is_load_balancer_idle'
description: Is load balancer idle
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Check if cluster load balancer is idle
tags:
- cluster-info
/gflags:
get:
description: Retrieve gflags of master and tserver process
operationId: getGflags
parameters:
- description: Specify the node ip-address from where alerts are retrieved
explode: false
in: query
name: node_address
required: true
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GflagsInfo'
description: Gflags information
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get gflags of master and tserver process
tags:
- cluster-info
/alerts:
get:
description: Get any alerts for the cluster
operationId: getClusterAlerts
parameters:
- description: Specify the node ip-address from where gflags are retrieved
explode: false
in: query
name: node_address
required: true
schema:
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Alerts_Response'
description: Alerts information
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get any alerts for the cluster
tags:
- cluster-info
/connections:
get:
description: Get YSQL connection manager stats for every node of the cluster
operationId: getClusterConnections
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectionsStats'
description: YSQL connection manager stats
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get YSQL connection manager stats for every node of the cluster
tags:
- cluster-info
/node_address:
get:
description: Get the node address for the current node
operationId: getNodeAddress
responses:
'200':
content:
text/plain:
schema:
type: string
description: Node address
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the node address for the current node
tags:
- cluster-info
components:
schemas:
TabletInfo:
description: Tablet Info
example:
tablet_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
partition: partition
raft_config:
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
hidden: true
split_depth: 5
state: state
message: message
properties:
tablet_id:
format: uuid
type: string
partition:
type: string
split_depth:
type: integer
state:
type: string
hidden:
type: boolean
message:
type: string
raft_config:
items:
$ref: '#/components/schemas/RaftConfig'
type: array
title: Tablet Info
type: object
Cluster_table_list_response:
example:
tables:
- keyspace: keyspace
size_bytes: 0
name: name
uuid: uuid
- keyspace: keyspace
size_bytes: 0
name: name
uuid: uuid
indexes:
- keyspace: keyspace
size_bytes: 0
name: name
uuid: uuid
- keyspace: keyspace
size_bytes: 0
name: name
uuid: uuid
properties:
tables:
description: List of cluster tables
items:
$ref: '#/components/schemas/ClusterTable'
title: Cluster Table Data
type: array
uniqueItems: true
indexes:
description: List of cluster tables
items:
$ref: '#/components/schemas/ClusterTable'
title: Cluster Table Data
type: array
uniqueItems: true
required:
- indexes
- tables
title: Cluster table list response
type: object
LiveQueryResponseYSQLData:
description: Schema for Live Query Response YSQL Data
example:
error_count: 0
queries:
- app_name: app_name
client_port: client_port
db_name: db_name
query_start_time: query_start_time
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 6
session_status: session_status
client_host: client_host
- app_name: app_name
client_port: client_port
db_name: db_name
query_start_time: query_start_time
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 6
session_status: session_status
client_host: client_host
properties:
error_count:
description: Count of Errors
type: integer
queries:
items:
$ref: '#/components/schemas/LiveQueryResponseYSQLQueryItem'
type: array
title: Live Query Response YSQL Data
type: object
LiveQueryResponseSchema:
description: Live Query Response Schema
example:
data:
ysql:
error_count: 0
queries:
- app_name: app_name
client_port: client_port
db_name: db_name
query_start_time: query_start_time
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 6
session_status: session_status
client_host: client_host
- app_name: app_name
client_port: client_port
db_name: db_name
query_start_time: query_start_time
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 6
session_status: session_status
client_host: client_host
ycql:
error_count: 1
queries:
- keyspace: keyspace
client_port: client_port
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 5
type: type
client_host: client_host
- keyspace: keyspace
client_port: client_port
query: query
node_name: node_name
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
elapsed_millis: 5
type: type
client_host: client_host
properties:
data:
$ref: '#/components/schemas/LiveQueryResponseData'
title: Live Query Response Schema
type: object
Gflag:
description: Gflag
example:
name: name
type: type
value: value
properties:
name:
type: string
value:
type: string
type:
type: string
title: Gflag
type: object
ApiError_error:
properties:
detail:
description: Error message
type: string
status:
description: Error code
type: integer
type: object
Health_Check_Response:
example:
data:
most_recent_uptime: 0
dead_nodes:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
leaderless_tablets:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
under_replicated_tablets:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
properties:
data:
$ref: '#/components/schemas/HealthCheckInfo'
title: Health Check Response
type: object
ConnectionStats:
items:
$ref: '#/components/schemas/ConnectionStatsItem'
type: array
GflagsInfo:
description: Gflags Info
example:
tserver_flags:
- name: name
type: type
value: value
- name: name
type: type
value: value
master_flags:
- name: name
type: type
value: value
- name: name
type: type
value: value
properties:
master_flags:
items:
$ref: '#/components/schemas/Gflag'
type: array
tserver_flags:
items:
$ref: '#/components/schemas/Gflag'
type: array
required:
- master_flags
- tserver_flags
title: Gflags Info
type: object
ActivityData:
description: Activity Data
example:
data: '{}'
name: name
properties:
name:
type: string
data:
type: object
required:
- data
- name
title: Activity Data
type: object
ClusterTable:
description: Model representing a DB table
example:
keyspace: keyspace
size_bytes: 0
name: name
uuid: uuid
properties:
name:
minLength: 1
type: string
keyspace:
minLength: 1
type: string
uuid:
minLength: 1
type: string
type:
$ref: '#/components/schemas/YbApiEnum'
size_bytes:
format: int64
minimum: 0
type: integer
required:
- keyspace
- name
- size_bytes
- type
- uuid
title: Cluster Table Object
type: object
SlowQueryResponseSchema:
description: Slow Query Response Schema
example:
data:
ysql:
error_count: 0
queries:
- query: query
datname: datname
local_blks_written: 5
rows: 3
stddev_time: 2.027123023002322
min_time: 9.301444243932576
queryid: 6
rolname: rolname
local_blks_hit: 5
calls: 1
max_time: 2.3021358869347655
mean_time: 7.061401241503109
total_time: 4.145608029883936
- query: query
datname: datname
local_blks_written: 5
rows: 3
stddev_time: 2.027123023002322
min_time: 9.301444243932576
queryid: 6
rolname: rolname
local_blks_hit: 5
calls: 1
max_time: 2.3021358869347655
mean_time: 7.061401241503109
total_time: 4.145608029883936
properties:
data:
$ref: '#/components/schemas/SlowQueryResponseData'
title: Slow Query Response Schema
type: object
SlowQueryResponseYSQLData:
description: Schema for Slow Query Response YSQL Data
example:
error_count: 0
queries:
- query: query
datname: datname
local_blks_written: 5
rows: 3
stddev_time: 2.027123023002322
min_time: 9.301444243932576
queryid: 6
rolname: rolname
local_blks_hit: 5
calls: 1
max_time: 2.3021358869347655
mean_time: 7.061401241503109
total_time: 4.145608029883936
- query: query
datname: datname
local_blks_written: 5
rows: 3
stddev_time: 2.027123023002322
min_time: 9.301444243932576
queryid: 6
rolname: rolname
local_blks_hit: 5
calls: 1
max_time: 2.3021358869347655
mean_time: 7.061401241503109
total_time: 4.145608029883936
properties:
error_count:
description: Count of Errors
type: integer
queries:
items:
$ref: '#/components/schemas/SlowQueryResponseYSQLQueryItem'
type: array
title: Slow Query Response YSQL Data
type: object
NodeData_metrics:
example:
system_tablets_total: 0
system_tablets_leaders: 0
write_ops_per_sec: 2.3021358869347655
ram_provisioned_bytes: 0
time_since_hb_sec: 7.061401241503109
active_connections:
ysql: 0
ycql: 0
total_sst_file_size_bytes: 1
uncompressed_sst_file_size_bytes: 5
read_ops_per_sec: 5.637376656633329
user_tablets_leaders: 0
ram_used_bytes: 0
memory_used_bytes: 6
uptime_seconds: 0
user_tablets_total: 0
disk_provisioned_bytes: 0
master_uptime_us: 0
properties:
memory_used_bytes:
default: 0
format: int64
type: integer
total_sst_file_size_bytes:
default: 0
format: int64
type:
- integer
- 'null'
uncompressed_sst_file_size_bytes:
default: 0
format: int64
type:
- integer
- 'null'
read_ops_per_sec:
default: 0
format: double
type: number
write_ops_per_sec:
default: 0
format: double
type: number
time_since_hb_sec:
default: 0
format: double
type: number
uptime_seconds:
default: 0
format: int64
minimum: 0
type: integer
user_tablets_total:
default: 0
format: int64
minimum: 0
type: integer
user_tablets_leaders:
default: 0
format: int64
minimum: 0
type: integer
system_tablets_total:
default: 0
format: int64
minimum: 0
type: integer
system_tablets_leaders:
default: 0
format: int64
minimum: 0
type: integer
active_connections:
$ref: '#/components/schemas/NodeData_metrics_active_connections'
master_uptime_us:
default: 0
format: int64
minimum: 0
type: integer
ram_used_bytes:
default: 0
format: int64
minimum: 0
type: integer
ram_provisioned_bytes:
default: 0
format: int64
minimum: 0
type: integer
disk_provisioned_bytes:
default: 0
format: int64
minimum: 0
type: integer
required:
- active_connections
- disk_provisioned_bytes
- master_uptime_us
- memory_used_bytes
- ram_provisioned_bytes
- ram_used_bytes
- read_ops_per_sec
- system_tablets_leaders
- system_tablets_total
- time_since_hb_sec
- total_sst_file_size_bytes
- uncompressed_sst_file_size_bytes
- uptime_seconds
- user_tablets_leaders
- user_tablets_total
- write_ops_per_sec
type: object
NodeData_cloud_info:
example:
cloud: cloud
zone: zone
region: region
properties:
cloud:
type: string
region:
type: string
zone:
type: string
required:
- region
- zone
type: object
Alerts_Response:
example:
data:
- name: name
info: info
- name: name
info: info
properties:
data:
items:
$ref: '#/components/schemas/AlertsInfo'
type: array
required:
- data
title: Alerts Response
type: object
TableInfo:
description: Table Info
example:
table_tablespace_oid: table_tablespace_oid
table_replication_info:
live_replicas:
placement_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
num_replicas: 6
placement_blocks:
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
read_replicas:
- placement_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
num_replicas: 6
placement_blocks:
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
- placement_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
num_replicas: 6
placement_blocks:
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
- cloud_info:
placement_region: placement_region
placement_zone: placement_zone
placement_cloud: placement_cloud
min_num_replicas: 1
table_state: table_state
table_state_message: table_state_message
columns:
- column: column
id: id
type: type
- column: column
id: id
type: type
table_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
table_version: 0
table_name: table_name
tablets:
- tablet_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
partition: partition
raft_config:
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
hidden: true
split_depth: 5
state: state
message: message
- tablet_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
partition: partition
raft_config:
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- role: role
location: location
uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabyte-cluster-info-api-openapi.yml