Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Universe node metadata (metamaster) API

The Universe node metadata (metamaster) API from YugabyteDB — 6 operation(s) for universe node metadata (metamaster).

YugabyteDB Universe node metadata (metamaster) API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Universe node metadata (metamaster). 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 6 operations across 6 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

6 operations 6 paths 8 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Universe node metadata (metamaster) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 6

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

Universe node metadata (metamaster) 6
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/master_lb_state
YugabyteDB Anywhere Get the State of Master Load Balancing Ops
getMasterLBState 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/masters
YugabyteDB Anywhere List a Master Node's Addresses
getMasterAddresses 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/redisservers
YugabyteDB Anywhere List a REDIS Server's Addresses
getRedisServerAddresses 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/yqlservers
YugabyteDB Anywhere List a YQL Server's Addresses
getYQLServerAddresses 2 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/ysqlservers
YugabyteDB Anywhere List a YSQL Server's Addresses
getYSQLServerAddresses 2 params → 200
GET
/metamaster/universe/{universeUUID}
YugabyteDB Anywhere List a Universe's Master Nodes
getUniverseMasterNodes 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CloudSpecificInfo (18 properties), CloudSpecificInfo_2 (18 properties), MasterLBStateResponse_2 (3 properties), MasterLBStateResponse (3 properties). Each schema is shown below with its type and property counts.

MasterNode
object
2 properties 2 required
MastersList
object
1 property 1 required
MasterLBStateResponse
object
Master tablet load balancer status
3 properties 1 required
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
MasterNode_2
object
2 properties 2 required
MastersList_2
object
1 property 1 required
MasterLBStateResponse_2
object
Master tablet load balancer status
3 properties 1 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-universe-node-metadata-metamaster-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API