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 API

APIs for cluster CRUD

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte cluster 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. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

3 operations 1 paths 15 schemas 1 DELETE1 GET1 PUT

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 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthToken). By default, every request must be authenticated.

Paths & Operations 3

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

cluster 3

APIs for cluster CRUD

DELETE
/cluster
Submit task to delete a cluster
deleteCluster → 200400500
GET
/cluster
Get a cluster
getCluster → 200400500
PUT
/cluster
Submit task to edit a cluster
editCluster body → 200400500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ClusterNodeInfo (6 properties), ClusterInfo (6 properties), ClusterDataInfo (5 properties), ClusterSpec (5 properties). Each schema is shown below with its type and property counts.

CloudInfo
object
Cloud deployment information
2 properties 2 required
ClusterSpec
object
Cluster spec
5 properties 6 required
ClusterFaultTolerance
string
The level of fault tolerance for the cluster
EncryptionInfo
object
Cluster encryption info
2 properties
ClusterData
object
Cluster data
2 properties 2 required
EntityMetadata
object
Common metadata for entities
2 properties
Cluster_Response
object
1 property
ApiError_error
object
2 properties
ClusterInfo
object
Cluster level information
6 properties 5 required
CloudEnum
string
Which cloud the cluster is deployed in
ClusterDataInfo
object
5 properties 5 required
ClusterRegionInfo
object
Cluster region info list
1 property 1 required
ClusterNodeInfo
object
Node level information
6 properties 4 required
PlacementInfo
object
2 properties 2 required
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-cluster-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-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
#Cluster
← Back to Y APIs
API Details
ID
yugabyte:yugabyte-cluster-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-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabyte-cluster-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 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.