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 Universe information API

The Universe information API from Yugabyte — 11 operation(s) for universe information.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte Universe information API is one of 82 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Universe information. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

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

Requests are made against a single base URL, /.

12 operations 11 paths 8 schemas 1 DELETE11 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
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Yugabyte Universe information API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 12

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

Universe information 12
GET
/api/v1/customers/{cUUID}/cost
Get a cost estimate for all universes
getUniverseCostForAll 1 param → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/costdeprecated
Get a cost estimate for a universe - deprecated
getUniverseCost 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/health_check
Return results for the last health check
healthCheckUniverse 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/leader
Get IP address of a universe's master leader
getMasterLeaderIP 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/live_queries
Get live queries for a universe
getLiveQueries 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/master_infos
Get master information list
getMasterInfos 2 params → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries
Reset slow queries for a universe
resetSlowQueries 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/slow_queries
Get slow queries for a universe
getSlowQueries 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/status
Get a universe's status
universeStatus 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/trigger_health_check
Trigger a universe health check
triggerHealthCheck 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/universe_resources
Get a resource usage estimate for a universe
getUniverseResources 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/{nodeName}/download_logsdeprecated
Download a node's logs - deprecated
downloadNodeLogs 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UniverseResourceDetails (11 properties), NodeData (11 properties), MasterInfo (5 properties), Details (5 properties). Each schema is shown below with its type and property counts.

Metric
object
4 properties 4 required
MasterInfo
object
Information about master
5 properties 5 required
Details
object
5 properties 4 required
TriggerHealthCheckResult
object
The response type for triggering a health check. Contains the timestamp of when the health check was triggered.
1 property
NodeData
object
11 properties 10 required
UniverseResourceDetails
object
11 properties
MetricLabel
object
2 properties 2 required
MetricValue
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-universe-information-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 Cluster Info 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
Yugabyte Access Keys API
AE Profile APIs.io
Yugabyte Accounts API
AE Profile APIs.io
#Universe information
← Back to Y APIs
API Details
ID
yugabyte:yugabyte-universe-information-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-universe-information-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabyte-universe-information-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 Universe information 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.