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

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte Universe management 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 management. 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 70 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

12 operations 11 paths 70 schemas 1 DELETE2 GET5 POST4 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

Yugabyte Universe management 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, 2 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Universe management 12
GET
/api/v1/customers/{cUUID}/universes
List universes
listUniverses 2 params → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}
Delete a universe
deleteUniverse 6 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}
Get a universe
getUniverse 2 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/config_alertsdeprecated
Configure alerts for a universe
configureUniverseAlerts 3 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible
Flag a universe as Helm 3-compatible - deprecated
setUniverseHelm3Compatible 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/pause
Pause a universe
pauseUniverse 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/resume
Resume a paused universe
resumeUniverse 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/set_key
Set a universe's key
setUniverseKey 3 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/setup_universe_2dc
Reset universe version
resetUniverseVersion 3 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
Set a universe's backup flag
setUniverseBackupFlag 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config
Update load balancer config
updateLoadBalancerConfig 3 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/toggle_tlsdeprecated
Toggle a universe's TLS state
toggleUniverseTLS 2 params → 200

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are UniverseDefinitionTaskParamsResp (64 properties), UserIntent (55 properties), NodeDetailsResp (39 properties), UniverseDefinitionTaskParamsResp_2 (37 properties). Each schema is shown below with its type and property counts.

YBPTask
object
2 properties
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
RegionCloudInfo
object
4 properties
NodeDetailsResp_2
object
29 properties
AdditionalServicesStateData
object
Additional services state
2 properties
XClusterInfo
object
1 property
PerProcessFlags
object
1 property 1 required
CommunicationPorts
object
Communication ports
15 properties
UniverseResp
object
Universe-creation response
15 properties
YBPSuccess
object
2 properties
Users
object
A user associated with a customer
12 properties 3 required
AWSRegionCloudInfo
object
4 properties
AllowedUniverseTasksResp
object
2 properties
CommunicationPorts_2
object
Communication ports
11 properties
PlacementRegion_2
object
4 properties
ExtraDependencies
object
Extra dependencies
1 property
UniverseDefinitionTaskParamsResp
object
64 properties 5 required
GCPRegionCloudInfo
object
2 properties
AuditLogConfig
object
Audit Log Configuration
4 properties 1 required
UserIntent_2
object
32 properties
RegionDetails
object
1 property
PlacementInfo
object
1 property 1 required
DeviceInfo_2
object
Device information
7 properties
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties 1 required
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
RollMaxBatchSize
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
UserIntent
object
55 properties
Cluster
object
7 properties 2 required
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties 8 required
MetricsExportConfig
object
Metrics Export Configuration
5 properties 1 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties 2 required
PrevYBSoftwareConfig
object
5 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
PlacementRegion
object
5 properties
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties 2 required
PlacementInfo_2
object
1 property 1 required
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PlacementCloud
object
4 properties
ProxyConfig
object
The Proxy Settings for the Universe
3 properties
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties 9 required
SpecificGFlags
object
GFlags for current cluster
4 properties
EarlyoomConfig
object
State for earlyoom service
6 properties
QueryLogConfig
object
Query Log Configuration
3 properties 1 required
ExtraDependencies_2
object
Extra dependencies
1 property
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
PlacementAZ_2
object
7 properties
AzureRegionCloudInfo
object
5 properties
UniverseResp_2
object
Universe-creation response
11 properties
PlacementAZ
object
9 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties 1 required
UpdateLoadBalancerConfig
object
5 properties 5 required
UniverseDefinitionTaskParamsResp_2
object
37 properties 1 required
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties 11 required
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
AvailabilityZoneDetails
object
1 property
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
K8SNodeResourceSpec
object
2 properties 2 required
AZCloudInfo
object
1 property
Cluster_2
object
6 properties 2 required
DeviceInfo
object
Device information
8 properties
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties 2 required
UniverseResourceDetails_2
object
11 properties
PlacementCloud_2
object
4 properties
NodeDetailsResp
object
39 properties 1 required
UserIntentOverrides
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
UniverseResourceDetails
object
11 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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