YugabyteDB Universe API
CRUD operations for a Universe
This API exposes 35 operations across 31 paths, and defines 115 schemas. It is described by OpenAPI 3.2.0, at version v2.
Requests are made against a single base URL, {protocol}://{host_port}/api/v2.
35 operations
31 paths
115 schemas
5 DELETE3 GET26 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Universe API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).
Paths & Operations 35
Across 31 paths, the API surfaces 35 operations — 5 DELETE, 3 GET, 26 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Universe 35
CRUD operations for a Universe
DELETE
/customers/{cUUID}/universes/{uniUUID}
Delete a universe
GET
/customers/{cUUID}/universes/{uniUUID}
Get a YugabyteDB Universe
PUT
/customers/{cUUID}/universes/{uniUUID}
Edit a YugabyteDB Universe
POST
/customers/{cUUID}/universes
Create a YugabyteDB Universe
POST
/customers/{cUUID}/universes/page
List universes
POST
/customers/{cUUID}/universes/{uniUUID}/clusters
Add a cluster to a YugabyteDB Universe
DELETE
/customers/{cUUID}/universes/{uniUUID}/clusters/{clsUUID}
Delete an additional cluster(s) of a YugabyteDB Universe
POST
/customers/{cUUID}/fetch-universe-resources
Get resource utilisation of a YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/gflags
Edit GFlags
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software
Upgrade YugabyteDB version
GET
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize
Get finalize information on the YugabyteDB upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize
Finalize the Upgrade YugabyteDB
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/third-party-software
Upgrade third party software
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/rollback
Rollback YugabyteDB version
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/resume-canary
Resume canary software upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck
Precheck YugabyteDB version upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/restart
Restart a YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/systemd
Migrate to Systemd controlled services
POST
/customers/{cUUID}/universes/{uniUUID}/encryption/in-transit
Enable or disable encryption in transit
POST
/customers/{cUUID}/universes/{uniUUID}/encryption/in-transit/rotate
Rotate TLS Certs
POST
/customers/{cUUID}/universes/{uniUUID}/kubernetes-overrides
Edit Kubernetes Helm Overrides
DELETE
/customers/{cUUID}/universes/{uniUUID}/detach
Rollback detach universe
POST
/customers/{cUUID}/universes/{uniUUID}/detach
Detach universe
POST
/customers/{cUUID}/universes/{uniUUID}/attach
Attach universe
DELETE
/customers/{cUUID}/universes/{uniUUID}/attach-detach-metadata
Delete attach/detach metadata
POST
/customers/{cUUID}/universes/{uniUUID}/query-log-config
Configure Query Log for YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/metrics-export-config
Configure metrics export
POST
/customers/{cUUID}/universes/{uniUUID}/export-telemetry-configs
Configure export telemetry configs (unified API)
POST
/customers/{cUUID}/universes/{uniUUID}/operator-import
Import universe to operator
POST
/customers/{cUUID}/universes/{uniUUID}/operator-import/precheck
Precheck universe import to operator
POST
/customers/{cUUID}/universes/{uniUUID}/run-script
Run a script on database nodes
POST
/customers/{cUUID}/universes/{uniUUID}/file-collections
Collect files from database nodes
GET
/customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID}/download
Download collected files
DELETE
/customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID}
Delete collected files from database nodes and/or YBA
POST
/customers/{cUUID}/universes/{uniUUID}/resize-nodes
Resize nodes in YBDB Universe
Schemas 115
The contract defines 115 schemas that model the data the API accepts and returns. The most detailed are UniverseInfo (34 properties), NodeDetails (21 properties), CloudSpecificInfo (18 properties), CommunicationPortsSpec (15 properties). Each schema is shown below with its type and property counts.
ScrapeConfigTargetType
string
Enum for target types that support metrics export scrape configuration.
AttachUniverseSpec
object
Request payload for attaching a universe.
1 property
UniverseSystemdEnableStart
object
UniverseSystemdEnableStart Payload to move the universe to use systemd to manage the YugabyteDB services
CollectedFileResult
object
Result of collecting a single file from a node
6 properties
2 required
UniverseSoftwareUpgradeFinalizeInfo
object
SoftwareUpgradesFinalizeInfo The list of connected xclusters that will be impacted by finalizing the software upgrade. Part of SoftwareUpgradeFinalizeResponse.
1 property
ClusterStorageSpec
object
Storage volume specification that is used for tserver nodes in this cluster. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec.
8 properties
2 required
KubernetesResourceDetails
object
Identifies the K8S Resource to operate upon. An internal object used as part of Universe edit operations.
3 properties
UniverseUpgradeOptionRolling
object
UniverseUpgradeOptionRolling Option for an upgrade to be rolling (one node at a time) or non-rolling (all nodes at once, with downtime)
2 properties
YCQLSpec
object
YCQL Spec for the Universe. Part of UniverseSpec.
3 properties
SoftwareUpgradeAZStep
object
AZ upgrade step: order is list order; pauseaftertserverupgrade controls canary pause after this AZ. Used for canary upgrade configuration.
2 properties
1 required
ClusterNodeSpec
object
Node settings (like CPU / memory) for each node in the cluster. The node settings configured at top-level are uniform settings for both tserver and master node…
YSQLQueryLogConfig
object
YSQL Query Logging Configuration. Part of QueryLogConfig.
10 properties
9 required
AvailabilityZoneNetworking
object
Networking properties for each node in the cluster. The settings can be configured at top-level for uniform node settings for both tserver and master nodes. Gr…
3 properties
MetricsExportConfig
Metrics Export Configuration Specification for the Universe. Part of Clusterspec.
YCQLAuditConfig
object
YCQL Audit Logging Configuration. Part of AuditLogConfig.
8 properties
8 required
CanaryUpgradeConfigSpec
object
Configuration for canary upgrade. Defines AZ order and pause points for primary and optional read-replica clusters. Part of UniverseSoftwareUpgradeStart.
3 properties
UniverseLogsExporterConfig
object
UniverseLogsExporterConfig Universe Logs Exporter Config. Part of AuditLogConfig.
CleanupCollectionInfo
object
Result of cleaning up collected files from database nodes
3 properties
3 required
MetricsTelemetrySpec
Metrics export. Omit or set to null to disable.
PerProcessResizeNodeSpec
object
Instance settings for each node in the cluster. The instances can be onprem nodes, VMs in GCP/AWS/Azure, or pods in k8s. Part of AvailabilityZoneNodeSpec and C…
2 properties
UniverseMetricsExporterConfig
object
UniverseMetricsExporterConfig Individual Metrics Exporter Configuration Specification.
UniverseRestart
object
UniverseRestart Payload to restart a Universe. Part of UniverseRestartReq. This will restart all nodes in the universe or just restart the master and tserver p…
UniverseCertRotateSpec
object
UniverseCertRotateSpec Request payload to rotate the certs used for encryption in transit. Part of UniverseCertRotateReq.
EncryptionInTransitSpec
object
Specification of node-to-node and client-to-node TLS encryption. Part of UniverseSpec.
4 properties
NodeDetails
object
Details of a cloud node. Part of UniverseInfo.
21 properties
AuditLogConfig
object
Audit Log Configuration Specification for the Universe. Part of Clusterspec.
4 properties
1 required
PlacementAZ
object
YBA Placement Availability Zone within Placement Region. Part of PlacementRegion.
9 properties
4 required
YSQLAuditConfig
object
YSQL Audit Logging Configuration. Part of AuditLogConfig.
11 properties
11 required
K8SNodeResourceSpec
object
K8SNodeResourceSpec Custom k8s resource spec is used to specify custom cpu and memory requests/limits for tserver and master pods of a cluster. Specified as pa…
2 properties
ScriptOptions
object
Configuration options for the script to be executed
6 properties
AvailabilityZoneResizeNodeSpec
object
Properties for each node in the cluster. The settings can be configured at top-level for uniform node settings for both tserver and master nodes. Granular sett…
ConfigureMetricsExportSpec
object
ConfigureMetricsExportSpec Configuration for metrics export from a universe to telemetry providers.
PaginationSpec
object
Pagination spec in page API requests.
3 properties
UniverseSoftwareUpgradePrecheckReq
object
UniverseSoftwareUpgradePrecheckReq Payload to precheck a YugabyteDB software upgrade on a Universe. Part of UniverseSoftwareUpgradePrecheckReq
1 property
1 required
DetachUniverseSpec
object
Request payload for detaching a universe.
1 property
UniverseQueryLogsExporterConfig
object
UniverseQueryLogsExporterConfig Universe Logs Exporter Config. Part of QueryLogConfig.
ClusterEditSpec
object
Edit Cluster Spec. Part of UniverseEditSpec.
7 properties
1 required
UniverseDeleteSpec
object
UniverseDeleteSpec Optional addtional parameters for deleting a universe.
3 properties
ClusterNetworkingSpec
object
The network settings configured at top-level are uniform settings for both tserver and master nodes. Granular settings for tserver and master (honoured if dedi…
Universe
object
Universe Contains the user provided spec and system generated info of a Universe. Returned as response payload for a GET request on a Universe.
2 properties
UniverseCreateSpec
object
UniverseCreateSpec Universe create time properties. This is used to create a new Universe.
2 properties
2 required
PlacementCloud
object
YBA Placement Cloud. Part of ClusterPlacementSpec.
5 properties
3 required
UserInfo
object
System generated properties of a User. Part of User.
7 properties
UniverseUpgradeOptionsAll
object
UniverseUpgradeOptionsAll Option on how to handle node reboots: Rolling - Apply upgrade to each node one at a time (Default) Non-rolling - Apply upgrade to all…
2 properties
ClusterProviderEditSpec
object
Edit Cloud Provider settings for the cluster. Part of ClusterAddSpec and ClusterEditSpec.
1 property
1 required
UniverseSpec
object
These are user configured properties of a Universe. Part of create Universe request payload. Returned as part of a Universe resource.
11 properties
3 required
EncryptionAtRestInfo
object
Encryption At Rest specification for the Universe. Part of UniverseInfo.
1 property
UniverseInfo
object
These are read-only system generated properties of a Universe. Returned as part of a Universe resource.
34 properties
EncryptionAtRestSpec
object
Encryption At Rest specification for the Universe. Part of UniverseSpec.
1 property
TelemetryConfig
object
Telemetry config. Each property is optional. Set to null or omit to disable that config. Empty object = disable all.
3 properties
NodeFileCollectionResult
object
Result of collecting files from a single node
11 properties
7 required
RollMaxBatchSize
object
Suggested number of tservers to roll during upgrade if available.
2 properties
UniverseSoftwareFinalizeImpactedXCluster
object
ImpactedXClusterInfo XCluster info that are impacted by software upgrade. Part of SoftwareUpgradesFinalize schema.
3 properties
3 required
RunScriptResponse
object
Response from running a script on database nodes
2 properties
2 required
MetricsExportConfigBase
object
Common metrics scrape and collection settings.
4 properties
AllowedTasksOnFailure
object
When the last Universe operation has failed, YB Anywhere prevents most Universe operations until this failure is first fixed. This property lists all the allow…
2 properties
UniverseSoftwareUpgradeStart
object
UniverseSoftwareUpgradeStart Payload to start a YugabyteDB software upgrade on a Universe. Part of UniverseSoftwareUpgradeReq
NodeProxyConfig
object
The Proxy Settings for the nodes in the Universe. NodeProxyConfig is part of NodeSpec.
3 properties
FileCollectionOptions
object
Configuration options for collecting files from database nodes. At least one of filepaths or directorypaths must be provided.
7 properties
YBATask
object
YBATask YugabyteDB Anywhere Task object is used to represent a task that is being executed on a resource. This Task object can be polled for progress and statu…
2 properties
ClusterGFlags
object
GFlags for a single cluster of a YugabyteDB Universe. Used as part of ClusterSpec at Universe create time, and as part of UniverseEditGFlags to edit GFlags for…
UniverseNetworkingSpec
object
Networking specification that is used for nodes in this Universe. Part of UniverseSpec.
4 properties
YbSoftwareDetails
object
YbSoftwareDetails YugabyteDB Software Details object is used to represent the software version of YugabyteDB running on a Universe.
2 properties
UserSpec
object
A user associated with a customer
2 properties
1 required
CloudVolumeEncryption
object
Volume encryption settings for cloud volumes (currently AWS EBS volumes only)
2 properties
NodeSelection
object
Options for selecting which nodes to run the script on
5 properties
CollectFilesRequest
object
Request body for collecting files from database nodes
2 properties
1 required
UniverseEditSpec
object
UniverseEditSpec Request payload to edit an existing Universe. Not all properties of a UniverseSpec can be updated. This is a partial update. Only the fields t…
2 properties
2 required
ClusterResizeNodeSpec
object
Node settings (like CPU / memory) for each node in the cluster. The node settings configured at top-level are uniform settings for both tserver and master node…
UniverseQueryLogsExport
object
UniverseQueryLogsExport Payload to configure export of query logs. Part of UniverseQueryLogsExportReq
XClusterInfo
object
XCluster related states in this universe. Part of UniverseInfo.
3 properties
CommunicationPortsSpec
object
Communication Ports used by nodes of this Universe. Part of UniverseNetworkingSpec.
15 properties
PerProcessNodeSpec
object
Instance settings for each node in the cluster. The instances can be onprem nodes, VMs in GCP/AWS/Azure, or pods in k8s. Part of AvailabilityZoneNodeSpec and C…
2 properties
UniverseSoftwareUpgradePrecheckResp
object
UniverseSoftwareUpgradePrecheckResp Response to a YugabyteDB software upgrade precheck on a Universe. Returns if a finalize is required. Part of UniverseSoftwa…
2 properties
1 required
UniverseExporterConfig
object
UniverseExporterConfig Universe Exporter Config. Base configuration for exporters in the Universe. Used for AuditLogConfig, QueryLogConfig, MetricsExportConfig.
2 properties
1 required
ClusterSpec
object
Universe Cluster Spec. Part of UniverseSpec.
15 properties
4 required
AuditLogsTelemetrySpec
object
Audit logs (YSQL/YCQL). Omit or set to null to disable.
3 properties
UniverseSoftwareUpgradeFinalize
object
UniverseSoftwareUpgradeFinalize Payload to finalize a YugabyteDB software upgrade on a Universe
1 property
UniverseThirdPartySoftwareUpgradeStart
UniverseThirdPartyUpgradeStart Payload to start a third party software upgrade on a Universe. Part of UniverseThirdPartyUpgradeReq
ExecutionSummary
object
Summary of script execution across all targeted nodes
5 properties
4 required
UniversePagedResp
object
UniverseOperatorImportReq
object
UniverseOperatorImportReq Payload to import a universe to the operator. Part of UniverseOperatorImportReq
1 property
UniverseResizeNodes
object
UniverseResizeNodes Request payload to update the size of nodes in a universe. Update the instance type and storage spec of the nodes. Part of UniverseResizeNo…
YSQLSpec
object
YSQL Spec for the Universe. Part of UniverseSpec.
4 properties
PlacementRegion
object
YBA Placement Region. Part of PlacementCloud.
5 properties
3 required
TelemetryExporterEntry
object
Exporter reference and optional overrides for a telemetry config.
8 properties
1 required
UniverseEditEncryptionInTransit
object
UniverseEditEncryptionInTransit Request Payload to enable or disable encryption in transit. Encryption in transit can be toggled for either node to node traffi…
QueryLogsTelemetrySpec
object
Query logs (YSQL). Omit or set to null to disable.
2 properties
UniversePagedQuerySpec
object
CloudSpecificInfo
object
Node information reported by the Cloud Provider. Part of NodeDetails.
18 properties
RunScriptRequest
object
Request body for running a script on database nodes
2 properties
1 required
ExportTelemetryConfigSpec
object
Request to configure all telemetry export configs for a universe
2 properties
UniverseRollbackUpgradeReq
object
UniverseRollbackUpgrade Payload to rollback a YugabyteDB software upgrade on a Universe. Part of UniverseRollbackUpgradeReq
UniverseListApiFilter
object
Optional filter for listing universes. Matches V1 GET /api/customers/{id}/universes?name=... behavior (exact name match).
1 property
ClusterInfo
object
Universe Cluster Info. Part of the Response payload UniverseInfo that describes system generated properties of a Cluster.
2 properties
AvailabilityZoneGFlags
object
GFlags for tserver and master. Part of ClusterGFlags.
2 properties
QueryLogConfig
object
Query Log Configuration Specification for the Universe. Part of Clusterspec.
3 properties
1 required
ClusterAddSpec
object
ClusterAddSpec Request payload to add a new cluster to an existing YugabyteDB Universe.
8 properties
4 required
UniverseEditGFlags
object
UniverseEditGFlags Request payload to edit GFlags of a Universe.
UniverseResourceDetails
object
Universe resource details. Part of UniverseInfo.
11 properties
1 required
ClusterResizeStorageSpec
object
Storage volume specification that is used for tserver nodes in this cluster. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec.
3 properties
UniverseEditKubernetesOverrides
object
UniverseEditKubernetesOverrides Update all kubernetes overrides on the universe. Part of UniverseKubernetesOverridesReq
2 properties
ClusterProviderSpec
object
Cloud Provider settings for the cluster. Part of ClusterSpec.
8 properties
1 required
AvailabilityZoneNodeSpec
object
Properties for each node in the cluster. The settings can be configured at top-level for uniform node settings for both tserver and master nodes. Granular sett…
UniverseResizeNodesCluster
object
UniverseResizeNodesCluster A single cluster for UniverseResizeNodes.
3 properties
2 required
NodeScriptResult
object
Result of script execution on a single node
8 properties
3 required
ClusterPlacementSpec
object
Data Placement Specification for the cluster. Part of ClusterSpec. Note that this is optional to configure. YugabyteDB Anywhere will automatically place the da…
1 property
1 required
ClusterPartitionSpec
object
Cluster Partition specification. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec. Future substitute for placementspec. Cluster should contain one or mo…
6 properties
5 required
FileCollectionSummary
object
Summary of file collection across all nodes
10 properties
6 required
UniverseResumeCanaryUpgrade
object
UniverseResumeCanaryUpgrade Payload to resume a paused canary software upgrade on a Universe.
1 property
1 required
CollectFilesResponse
object
Response from collecting files from database nodes
2 properties
2 required
User
object
User Contains the user provided spec and system generated info of a User. Returned as response payload for a GET request on a User. Also part of User property…
2 properties
ExportTelemetryUpgradeOptions
object
Upgrade options for applying telemetry config changes (rolling vs non-rolling, delays).
5 properties
PaginationResp
object
Pagination information in page API responses.
3 properties
SleepAfterRestartSchema
object
Time to wait after restarting a tserver or master process
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Universe
Where this information came from
This is an independent, third-party profile of YugabyteDB Universe 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.