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
Yugabytedb

YugabyteDB Clusters API

Create, list, retrieve, update, pause, resume, and delete YugabyteDB clusters within an account and project. Supports both single-region and multi-region cluster configurations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

7 operations 4 paths 7 schemas 1 DELETE2 GET3 POST1 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 Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Clusters 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 7

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

Clusters 7

Create, list, retrieve, update, pause, resume, and delete YugabyteDB clusters within an account and project. Supports both single-region and multi-region cluster configurations.

GET
/accounts/{accountId}/projects/{projectId}/clusters
YugabyteDB Aeon List Clusters
listClusters 2 params → 200401
POST
/accounts/{accountId}/projects/{projectId}/clusters
YugabyteDB Aeon Create Cluster
createCluster 2 params body → 200400401
GET
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}
YugabyteDB Aeon Get Cluster
getCluster 3 params → 200401404
PUT
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}
YugabyteDB Aeon Update Cluster
updateCluster 3 params body → 200400401404
DELETE
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}
YugabyteDB Aeon Delete Cluster
deleteCluster 3 params → 200401404
POST
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/pause
YugabyteDB Aeon Pause Cluster
pauseCluster 3 params → 200400401404
POST
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/resume
YugabyteDB Aeon Resume Cluster
resumeCluster 3 params → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Cluster (8 properties), ClusterInfo (5 properties), ClusterSpec (3 properties), ClusterEndpoint (3 properties). Each schema is shown below with its type and property counts.

ClusterInfo
object
Compute and storage configuration for a cluster.
5 properties
CloudInfo
object
Cloud provider and region configuration for a cluster.
2 properties
NodeInfo
object
Per-node compute and storage resource allocation.
3 properties
ClusterEndpoint
object
A connection endpoint for a YugabyteDB Aeon cluster.
3 properties
ErrorResponse
object
Standard error response returned by the API on failure.
1 property
ClusterSpec
object
Specification used to create or update a YugabyteDB Aeon cluster.
3 properties 3 required
Cluster
object
A YugabyteDB Aeon managed database cluster.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-clusters-api-openapi.yml Raw ↑
#Cluster
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-clusters-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
Yugabytedb
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=yugabytedb-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-clusters-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 YugabyteDB Clusters 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.