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 UniverseClusterMutations API

The UniverseClusterMutations API from YugabyteDB — 4 operation(s) for universeclustermutations.

Documentation Provider Profile APIs.io OpenAPI GitHub

YugabyteDB UniverseClusterMutations API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UniverseClusterMutations. 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 5 operations across 4 paths, and defines 151 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

5 operations 4 paths 151 schemas 1 DELETE2 POST2 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
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

YugabyteDB UniverseClusterMutations 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 5

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

UniverseClusterMutations 5
POST
/api/v1/customers/{cUUID}/universes/clusters
Create Universe Clusters
createAllClusters 2 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/primary
Update Primary Cluster
updatePrimaryCluster 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only
Create ReadOnly Cluster
createReadOnlyCluster 3 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only
Update Readonly Cluster
updateReadOnlyCluster 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only/{clustUUID}
Delete Readonly Cluster
deleteReadonlyCluster 5 params → 200

Schemas 151

The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are UniverseConfigureTaskParams_4 (67 properties), UniverseConfigureTaskParams_3 (67 properties), UniverseConfigureTaskParams (67 properties), UniverseDefinitionTaskParams_3 (64 properties). Each schema is shown below with its type and property counts.

PlacementRegion
object
5 properties
PerProcessFlags
object
1 property 1 required
AuditLogConfig
object
Audit Log Configuration
4 properties 1 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo
object
4 properties
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties 8 required
Users
object
A user associated with a customer
12 properties 3 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties 2 required
K8SNodeResourceSpec
object
2 properties 2 required
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties 11 required
ExtraDependencies
object
Extra dependencies
1 property
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties 2 required
DeviceInfo
object
Device information
8 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
QueryLogConfig
object
Query Log Configuration
3 properties 1 required
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
AzureRegionCloudInfo
object
5 properties
XClusterInfo
object
1 property
ProxyConfig
object
The Proxy Settings for the Universe
3 properties
UserIntentOverrides
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
AZCloudInfo
object
1 property
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
PerProcessDetails
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo
object
22 properties 1 required
Cluster
object
7 properties 2 required
PrevYBSoftwareConfig
object
5 properties
AdditionalServicesStateData
object
Additional services state
2 properties
MetricsExportConfig
object
Metrics Export Configuration
5 properties 1 required
PlacementAZ
object
9 properties
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo
object
2 properties
RegionCloudInfo
object
4 properties
UserIntent
object
55 properties
AvailabilityZoneDetails
object
1 property
RegionDetails
object
1 property
NodeDetails
object
Details of a cloud node
37 properties
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties 1 required
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties 2 required
PlacementCloud
object
4 properties
EarlyoomConfig
object
State for earlyoom service
6 properties
UniverseConfigureTaskParams
object
67 properties 5 required
CommunicationPorts
object
Communication ports
15 properties
UniverseDefinitionTaskParams
object
64 properties 5 required
PlacementInfo
object
1 property 1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties 9 required
YBPTask
object
2 properties
PlacementRegion_2
object
4 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties 1 required
PlacementCloud_2
object
4 properties
YBPTask_2
object
2 properties
Cluster_2
object
6 properties 2 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
PlacementAZ_2
object
7 properties
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
UniverseConfigureTaskParams_2
object
40 properties 1 required
CommunicationPorts_2
object
Communication ports
11 properties
UniverseDefinitionTaskParams_2
object
37 properties 1 required
UserIntent_2
object
32 properties
ExtraDependencies_2
object
Extra dependencies
1 property
PlacementInfo_2
object
1 property 1 required
DeviceInfo_2
object
Device information
7 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
NodeDetails_2
object
Details of a cloud node
28 properties
PlacementRegion_3
object
5 properties
PerProcessFlags_2
object
1 property 1 required
AuditLogConfig_2
object
Audit Log Configuration
4 properties 1 required
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo_2
object
4 properties
YCQLAuditConfig_2
object
YCQL Audit Logging Configuration
8 properties 8 required
Users_2
object
A user associated with a customer
12 properties 3 required
UniverseLogsExporterConfig_2
object
Universe Logs Exporter Config
2 properties 2 required
K8SNodeResourceSpec_2
object
2 properties 2 required
YSQLAuditConfig_2
object
YSQL Audit Logging Configuration
11 properties 11 required
ExtraDependencies_3
object
Extra dependencies
1 property
UniverseMetricsExporterConfig_2
object
Metrics Exporter Configuration
8 properties 2 required
DeviceInfo_3
object
Device information
8 properties
SpecificGFlags_2
object
GFlags for current cluster
4 properties
QueryLogConfig_2
object
Query Log Configuration
3 properties 1 required
EncryptionAtRestConfig_3
object
Encryption at rest configuration
4 properties
AzureRegionCloudInfo_2
object
5 properties
XClusterInfo_2
object
1 property
UserIntentOverrides_2
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudSpecificInfo_3
object
Node information reported by the cloud provider
18 properties
Region_3
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
PerProcessDetails_2
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo_2
object
22 properties 1 required
Cluster_3
object
7 properties 2 required
PrevYBSoftwareConfig_2
object
5 properties
AdditionalServicesStateData_2
object
Additional services state
2 properties
MetricsExportConfig_2
object
Metrics Export Configuration
5 properties 1 required
PlacementAZ_3
object
9 properties
AZOverrides_2
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo_2
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo_2
object
2 properties
UserIntent_3
object
55 properties
NodeDetails_3
object
Details of a cloud node
37 properties
AvailabilityZone_3
object
Availability zone (AZ) for a region
9 properties 1 required
UniverseQueryLogsExporterConfig_2
object
Universe Logs Exporter Config
7 properties 2 required
PlacementCloud_3
object
4 properties
EarlyoomConfig_2
object
State for earlyoom service
6 properties
UniverseConfigureTaskParams_3
object
67 properties 5 required
CommunicationPorts_3
object
Communication ports
15 properties
UniverseDefinitionTaskParams_3
object
64 properties 5 required
PlacementInfo_3
object
1 property 1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration
10 properties 9 required
YBPTask_3
object
2 properties
PlacementRegion_4
object
5 properties
PerProcessFlags_3
object
1 property 1 required
AuditLogConfig_3
object
Audit Log Configuration
4 properties 1 required
CloudVolumeEncryption_3
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo_3
object
4 properties
YCQLAuditConfig_3
object
YCQL Audit Logging Configuration
8 properties 8 required
Users_3
object
A user associated with a customer
12 properties 3 required
UniverseLogsExporterConfig_3
object
Universe Logs Exporter Config
2 properties 2 required
K8SNodeResourceSpec_3
object
2 properties 2 required
YSQLAuditConfig_3
object
YSQL Audit Logging Configuration
11 properties 11 required
ExtraDependencies_4
object
Extra dependencies
1 property
UniverseMetricsExporterConfig_3
object
Metrics Exporter Configuration
8 properties 2 required
DeviceInfo_4
object
Device information
8 properties
SpecificGFlags_3
object
GFlags for current cluster
4 properties
QueryLogConfig_3
object
Query Log Configuration
3 properties 1 required
EncryptionAtRestConfig_4
object
Encryption at rest configuration
4 properties
AzureRegionCloudInfo_3
object
5 properties
XClusterInfo_3
object
1 property
UserIntentOverrides_3
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudSpecificInfo_4
object
Node information reported by the cloud provider
18 properties
Region_4
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
PerProcessDetails_3
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo_3
object
22 properties 1 required
Cluster_4
object
7 properties 2 required
PrevYBSoftwareConfig_3
object
5 properties
AdditionalServicesStateData_3
object
Additional services state
2 properties
MetricsExportConfig_3
object
Metrics Export Configuration
5 properties 1 required
PlacementAZ_4
object
9 properties
AZOverrides_3
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo_3
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo_3
object
2 properties
UserIntent_4
object
55 properties
NodeDetails_4
object
Details of a cloud node
37 properties
AvailabilityZone_4
object
Availability zone (AZ) for a region
9 properties 1 required
UniverseQueryLogsExporterConfig_3
object
Universe Logs Exporter Config
7 properties 2 required
PlacementCloud_4
object
4 properties
EarlyoomConfig_3
object
State for earlyoom service
6 properties
UniverseConfigureTaskParams_4
object
67 properties 5 required
CommunicationPorts_4
object
Communication ports
15 properties
UniverseDefinitionTaskParams_4
object
64 properties 5 required
PlacementInfo_4
object
1 property 1 required
YSQLQueryLogConfig_3
object
YSQL Query Logging Configuration
10 properties 9 required
YBPTask_4
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-universeclustermutations-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#UniverseClusterMutations
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-universeclustermutations-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-universeclustermutations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-universeclustermutations-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 UniverseClusterMutations 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.