YugabyteDB Universe API
CRUD operations for a Universe
YugabyteDB Universe API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Universe. 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 35 operations across 31 paths, and defines 191 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.
35 operations
31 paths
191 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.
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 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}
YugabyteDB Anywhere Delete a Universe
GET
/customers/{cUUID}/universes/{uniUUID}
YugabyteDB Anywhere Get a YugabyteDB Universe
PUT
/customers/{cUUID}/universes/{uniUUID}
YugabyteDB Anywhere Edit a YugabyteDB Universe
POST
/customers/{cUUID}/universes
YugabyteDB Anywhere Create a YugabyteDB Universe
POST
/customers/{cUUID}/universes/page
YugabyteDB Anywhere List Universes
POST
/customers/{cUUID}/universes/{uniUUID}/clusters
YugabyteDB Anywhere Add a Cluster to a YugabyteDB Universe
DELETE
/customers/{cUUID}/universes/{uniUUID}/clusters/{clsUUID}
YugabyteDB Anywhere Delete an Additional Cluster(s) of a YugabyteDB Universe
POST
/customers/{cUUID}/fetch-universe-resources
YugabyteDB Anywhere Get Resource Utilisation of a YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/gflags
YugabyteDB Anywhere Edit GFlags
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software
YugabyteDB Anywhere Upgrade YugabyteDB Version
GET
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize
YugabyteDB Anywhere Get Finalize Information on the YugabyteDB Upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize
YugabyteDB Anywhere Finalize the Upgrade YugabyteDB
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/third-party-software
YugabyteDB Anywhere Upgrade Third Party Software
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/rollback
YugabyteDB Anywhere Rollback YugabyteDB Version
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/resume-canary
YugabyteDB Anywhere Resume Canary Software Upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck
YugabyteDB Anywhere Precheck YugabyteDB Version Upgrade
POST
/customers/{cUUID}/universes/{uniUUID}/restart
YugabyteDB Anywhere Restart a YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/systemd
YugabyteDB Anywhere Migrate to Systemd Controlled Services
POST
/customers/{cUUID}/universes/{uniUUID}/encryption/in-transit
YugabyteDB Anywhere Enable or Disable Encryption in Transit
POST
/customers/{cUUID}/universes/{uniUUID}/encryption/in-transit/rotate
YugabyteDB Anywhere Rotate TLS Certs
POST
/customers/{cUUID}/universes/{uniUUID}/kubernetes-overrides
YugabyteDB Anywhere Edit Kubernetes Helm Overrides
DELETE
/customers/{cUUID}/universes/{uniUUID}/detach
YugabyteDB Anywhere Rollback Detach Universe
POST
/customers/{cUUID}/universes/{uniUUID}/detach
YugabyteDB Anywhere Detach Universe
POST
/customers/{cUUID}/universes/{uniUUID}/attach
YugabyteDB Anywhere Attach Universe
DELETE
/customers/{cUUID}/universes/{uniUUID}/attach-detach-metadata
YugabyteDB Anywhere Delete Attach/detach Metadata
POST
/customers/{cUUID}/universes/{uniUUID}/query-log-config
YugabyteDB Anywhere Configure Query Log for YugabyteDB Universe
POST
/customers/{cUUID}/universes/{uniUUID}/metrics-export-config
YugabyteDB Anywhere Configure Metrics Export
POST
/customers/{cUUID}/universes/{uniUUID}/export-telemetry-configs
YugabyteDB Anywhere Configure Export Telemetry Configs (unified API)
POST
/customers/{cUUID}/universes/{uniUUID}/operator-import
YugabyteDB Anywhere Import Universe to Operator
POST
/customers/{cUUID}/universes/{uniUUID}/operator-import/precheck
YugabyteDB Anywhere Precheck Universe Import to Operator
POST
/customers/{cUUID}/universes/{uniUUID}/run-script
YugabyteDB Anywhere Run a Script on Database Nodes
POST
/customers/{cUUID}/universes/{uniUUID}/file-collections
YugabyteDB Anywhere Collect Files from Database Nodes
GET
/customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID}/download
YugabyteDB Anywhere Download Collected Files
DELETE
/customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID}
YugabyteDB Anywhere Delete Collected Files from Database Nodes And/or YBA
POST
/customers/{cUUID}/universes/{uniUUID}/resize-nodes
YugabyteDB Anywhere Resize Nodes in YBDB Universe.
Schemas 191
The contract defines 191 schemas that model the data the API accepts and returns. The most detailed are UniverseInfo_2 (34 properties), UniverseInfo (34 properties), NodeDetails_2 (21 properties), NodeDetails (21 properties). Each schema is shown below with its type and property counts.
MetricsExportConfigBase
object
Common metrics scrape and collection settings.
4 properties
QueryLogsTelemetrySpec
object
Query logs (YSQL). Omit or set to null to disable.
2 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…
ExportTelemetryConfigSpec
object
Request to configure all telemetry export configs for a universe
2 properties
EncryptionAtRestSpec
object
Encryption At Rest specification for the Universe. Part of UniverseSpec.
1 property
ClusterSpec
object
Universe Cluster Spec. Part of UniverseSpec.
15 properties
4 required
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
ClusterAddSpec
object
ClusterAddSpec Request payload to add a new cluster to an existing YugabyteDB Universe.
8 properties
4 required
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…
TelemetryConfig
object
Telemetry config. Each property is optional. Set to null or omit to disable that config. Empty object = disable all.
3 properties
NodeProxyConfig
object
The Proxy Settings for the nodes in the Universe. NodeProxyConfig is part of NodeSpec.
3 properties
PaginationSpec
object
Pagination spec in page API requests.
3 properties
RunScriptRequest
object
Request body for running a script on database nodes
2 properties
1 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
ClusterEditSpec
object
Edit Cluster Spec. Part of UniverseEditSpec.
7 properties
1 required
AuditLogConfig
object
Audit Log Configuration Specification for the Universe. Part of Clusterspec.
4 properties
1 required
DetachUniverseSpec
object
Request payload for detaching a universe.
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
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
UserSpec
object
A user associated with a customer
2 properties
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
UniverseSystemdEnableStart
object
UniverseSystemdEnableStart Payload to move the universe to use systemd to manage the YugabyteDB services
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
FileCollectionSummary
object
Summary of file collection across all nodes
10 properties
6 required
NodeScriptResult
object
Result of script execution on a single node
8 properties
3 required
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
XClusterInfo
object
XCluster related states in this universe. Part of UniverseInfo.
3 properties
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
AttachUniverseSpec
object
Request payload for attaching a universe.
1 property
UniverseEditKubernetesOverrides
object
UniverseEditKubernetesOverrides Update all kubernetes overrides on the universe. Part of UniverseKubernetesOverridesReq
2 properties
EncryptionInTransitSpec
object
Specification of node-to-node and client-to-node TLS encryption. Part of UniverseSpec.
4 properties
UniverseQueryLogsExporterConfig
object
UniverseQueryLogsExporterConfig Universe Logs Exporter Config. Part of QueryLogConfig.
UniverseSoftwareUpgradeFinalizeInfo
object
SoftwareUpgradesFinalizeInfo The list of connected xclusters that will be impacted by finalizing the software upgrade. Part of SoftwareUpgradeFinalizeResponse.
1 property
UniverseEditGFlags
object
UniverseEditGFlags Request payload to edit GFlags of a Universe.
UniverseQueryLogsExport
object
UniverseQueryLogsExport Payload to configure export of query logs. Part of UniverseQueryLogsExportReq
CollectFilesRequest
object
Request body for collecting files from database nodes
2 properties
1 required
CommunicationPortsSpec
object
Communication Ports used by nodes of this Universe. Part of UniverseNetworkingSpec.
15 properties
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…
PaginationResp
object
Pagination information in page API responses.
3 properties
UniversePagedQuerySpec
object
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…
ExportTelemetryUpgradeOptions
object
Upgrade options for applying telemetry config changes (rolling vs non-rolling, delays).
5 properties
SleepAfterRestartSchema
object
Time to wait after restarting a tserver or master process
2 properties
CanaryUpgradeConfigSpec
object
Configuration for canary upgrade. Defines AZ order and pause points for primary and optional read-replica clusters. Part of UniverseSoftwareUpgradeStart.
3 properties
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…
AuditLogsTelemetrySpec
object
Audit logs (YSQL/YCQL). Omit or set to null to disable.
3 properties
RunScriptResponse
object
Response from running a script on database nodes
2 properties
2 required
ConfigureMetricsExportSpec
object
ConfigureMetricsExportSpec Configuration for metrics export from a universe to telemetry providers.
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
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…
UniverseCreateSpec
object
UniverseCreateSpec Universe create time properties. This is used to create a new Universe.
2 properties
2 required
UniversePagedResp
object
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…
TelemetryExporterEntry
object
Exporter reference and optional overrides for a telemetry config.
8 properties
1 required
YSQLSpec
object
YSQL Spec for the Universe. Part of UniverseSpec.
4 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
ClusterInfo
object
Universe Cluster Info. Part of the Response payload UniverseInfo that describes system generated properties of a Cluster.
2 properties
NodeDetails
object
Details of a cloud node. Part of UniverseInfo.
21 properties
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
CleanupCollectionInfo
object
Result of cleaning up collected files from database nodes
3 properties
3 required
MetricsExportConfig
Metrics Export Configuration Specification for the Universe. Part of Clusterspec.
UniverseNetworkingSpec
object
Networking specification that is used for nodes in this Universe. Part of UniverseSpec.
4 properties
ScriptOptions
object
Configuration options for the script to be executed
6 properties
NodeSelection
object
Options for selecting which nodes to run the script on
5 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
CloudSpecificInfo
object
Node information reported by the Cloud Provider. Part of NodeDetails.
18 properties
YCQLAuditConfig
object
YCQL Audit Logging Configuration. Part of AuditLogConfig.
8 properties
8 required
UniverseLogsExporterConfig
object
UniverseLogsExporterConfig Universe Logs Exporter Config. Part of AuditLogConfig.
EncryptionAtRestInfo
object
Encryption At Rest specification for the Universe. Part of UniverseInfo.
1 property
UniverseEditEncryptionInTransit
object
UniverseEditEncryptionInTransit Request Payload to enable or disable encryption in transit. Encryption in transit can be toggled for either node to node traffi…
KubernetesResourceDetails
object
Identifies the K8S Resource to operate upon. An internal object used as part of Universe edit operations.
3 properties
YbSoftwareDetails
object
YbSoftwareDetails YugabyteDB Software Details object is used to represent the software version of YugabyteDB running on a Universe.
2 properties
UniverseCertRotateSpec
object
UniverseCertRotateSpec Request payload to rotate the certs used for encryption in transit. Part of UniverseCertRotateReq.
UniverseSoftwareUpgradePrecheckReq
object
UniverseSoftwareUpgradePrecheckReq Payload to precheck a YugabyteDB software upgrade on a Universe. Part of UniverseSoftwareUpgradePrecheckReq
1 property
1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration. Part of QueryLogConfig.
10 properties
9 required
UniverseSoftwareUpgradeFinalize
object
UniverseSoftwareUpgradeFinalize Payload to finalize a YugabyteDB software upgrade on a Universe
1 property
NodeFileCollectionResult
object
Result of collecting files from a single node
11 properties
7 required
UniverseInfo
object
These are read-only system generated properties of a Universe. Returned as part of a Universe resource.
34 properties
PlacementAZ
object
YBA Placement Availability Zone within Placement Region. Part of PlacementRegion.
9 properties
4 required
ClusterResizeStorageSpec
object
Storage volume specification that is used for tserver nodes in this cluster. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec.
3 properties
UniverseRollbackUpgradeReq
object
UniverseRollbackUpgrade Payload to rollback a YugabyteDB software upgrade on a Universe. Part of UniverseRollbackUpgradeReq
UniverseMetricsExporterConfig
object
UniverseMetricsExporterConfig Individual Metrics Exporter Configuration Specification.
UniverseSoftwareFinalizeImpactedXCluster
object
ImpactedXClusterInfo XCluster info that are impacted by software upgrade. Part of SoftwareUpgradesFinalize schema.
3 properties
3 required
UniverseDeleteSpec
object
UniverseDeleteSpec Optional addtional parameters for deleting a universe.
3 properties
ClusterProviderEditSpec
object
Edit Cloud Provider settings for the cluster. Part of ClusterAddSpec and ClusterEditSpec.
1 property
1 required
PlacementCloud
object
YBA Placement Cloud. Part of ClusterPlacementSpec.
5 properties
3 required
PlacementRegion
object
YBA Placement Region. Part of PlacementCloud.
5 properties
3 required
UniverseResourceDetails
object
Universe resource details. Part of UniverseInfo.
11 properties
1 required
QueryLogConfig
object
Query Log Configuration Specification for the Universe. Part of Clusterspec.
3 properties
1 required
ClusterProviderSpec
object
Cloud Provider settings for the cluster. Part of ClusterSpec.
8 properties
1 required
UniverseResumeCanaryUpgrade
object
UniverseResumeCanaryUpgrade Payload to resume a paused canary software upgrade on a Universe.
1 property
1 required
YCQLSpec
object
YCQL Spec for the Universe. Part of UniverseSpec.
3 properties
CollectedFileResult
object
Result of collecting a single file from a node
6 properties
2 required
MetricsTelemetrySpec
Metrics export. Omit or set to null to disable.
UserInfo
object
System generated properties of a User. Part of User.
7 properties
UniverseExporterConfig
object
UniverseExporterConfig Universe Exporter Config. Base configuration for exporters in the Universe. Used for AuditLogConfig, QueryLogConfig, MetricsExportConfig.
2 properties
1 required
ExecutionSummary
object
Summary of script execution across all targeted nodes
5 properties
4 required
RollMaxBatchSize
object
Suggested number of tservers to roll during upgrade if available.
2 properties
UniverseResizeNodesCluster
object
UniverseResizeNodesCluster A single cluster for UniverseResizeNodes.
3 properties
2 required
AvailabilityZoneGFlags
object
GFlags for tserver and master. Part of ClusterGFlags.
2 properties
YSQLAuditConfig
object
YSQL Audit Logging Configuration. Part of AuditLogConfig.
11 properties
11 required
UniverseThirdPartySoftwareUpgradeStart
UniverseThirdPartyUpgradeStart Payload to start a third party software upgrade on a Universe. Part of UniverseThirdPartyUpgradeReq
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
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
UniverseOperatorImportReq
object
UniverseOperatorImportReq Payload to import a universe to the operator. Part of UniverseOperatorImportReq
1 property
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
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
UniverseListApiFilter
object
Optional filter for listing universes. Matches V1 GET /api/customers/{id}/universes?name=... behavior (exact name match).
1 property
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…
FileCollectionOptions
object
Configuration options for collecting files from database nodes. At least one of filepaths or directorypaths must be provided.
7 properties
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
ScrapeConfigTargetType
string
Enum for target types that support metrics export scrape configuration.
CloudVolumeEncryption
object
Volume encryption settings for cloud volumes (currently AWS EBS volumes only)
2 properties
QueryLogsTelemetrySpec_2
object
Query logs (YSQL). Omit or set to null to disable.
2 properties
ClusterSpec_2
object
Universe Cluster Spec. Part of UniverseSpec.
15 properties
4 required
AllowedTasksOnFailure_2
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_2
object
UniverseSoftwareUpgradeStart Payload to start a YugabyteDB software upgrade on a Universe. Part of UniverseSoftwareUpgradeReq
ClusterAddSpec_2
object
ClusterAddSpec Request payload to add a new cluster to an existing YugabyteDB Universe.
8 properties
4 required
UniverseRestart_2
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…
PaginationSpec_2
object
Pagination spec in page API requests.
3 properties
AvailabilityZoneNetworking_2
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
ClusterEditSpec_2
object
Edit Cluster Spec. Part of UniverseEditSpec.
7 properties
1 required
AuditLogConfig_2
object
Audit Log Configuration Specification for the Universe. Part of Clusterspec.
4 properties
1 required
DetachUniverseSpec_2
object
Request payload for detaching a universe.
1 property
ClusterStorageSpec_2
object
Storage volume specification that is used for tserver nodes in this cluster. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec.
8 properties
2 required
SoftwareUpgradeAZStep_2
object
AZ upgrade step: order is list order; pauseaftertserverupgrade controls canary pause after this AZ. Used for canary upgrade configuration.
2 properties
1 required
UserSpec_2
object
A user associated with a customer
2 properties
1 required
ClusterPartitionSpec_2
object
Cluster Partition specification. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec. Future substitute for placementspec. Cluster should contain one or mo…
6 properties
5 required
XClusterInfo_2
object
XCluster related states in this universe. Part of UniverseInfo.
3 properties
UniverseSpec_2
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
AttachUniverseSpec_2
object
Request payload for attaching a universe.
1 property
UniverseQueryLogsExporterConfig_2
object
UniverseQueryLogsExporterConfig Universe Logs Exporter Config. Part of QueryLogConfig.
UniverseSoftwareUpgradeFinalizeInfo_2
object
SoftwareUpgradesFinalizeInfo The list of connected xclusters that will be impacted by finalizing the software upgrade. Part of SoftwareUpgradeFinalizeResponse.
1 property
UniverseEditGFlags_2
object
UniverseEditGFlags Request payload to edit GFlags of a Universe.
UniverseQueryLogsExport_2
object
UniverseQueryLogsExport Payload to configure export of query logs. Part of UniverseQueryLogsExportReq
UniverseResizeNodes_2
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…
PaginationResp_2
object
Pagination information in page API responses.
3 properties
ExportTelemetryUpgradeOptions_2
object
Upgrade options for applying telemetry config changes (rolling vs non-rolling, delays).
5 properties
SleepAfterRestartSchema_2
object
Time to wait after restarting a tserver or master process
2 properties
CanaryUpgradeConfigSpec_2
object
Configuration for canary upgrade. Defines AZ order and pause points for primary and optional read-replica clusters. Part of UniverseSoftwareUpgradeStart.
3 properties
ClusterNodeSpec_2
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…
AuditLogsTelemetrySpec_2
object
Audit logs (YSQL/YCQL). Omit or set to null to disable.
3 properties
RunScriptResponse_2
object
Response from running a script on database nodes
2 properties
2 required
ClusterGFlags_2
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…
UniversePagedResp_2
object
ClusterNetworkingSpec_2
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…
TelemetryExporterEntry_2
object
Exporter reference and optional overrides for a telemetry config.
8 properties
1 required
UniverseUpgradeOptionRolling_2
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
NodeDetails_2
object
Details of a cloud node. Part of UniverseInfo.
21 properties
UniverseEditSpec_2
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
CleanupCollectionInfo_2
object
Result of cleaning up collected files from database nodes
3 properties
3 required
MetricsExportConfig_2
Metrics Export Configuration Specification for the Universe. Part of Clusterspec.
UniverseSoftwareUpgradePrecheckResp_2
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
CloudSpecificInfo_2
object
Node information reported by the Cloud Provider. Part of NodeDetails.
18 properties
YCQLAuditConfig_2
object
YCQL Audit Logging Configuration. Part of AuditLogConfig.
8 properties
8 required
EncryptionAtRestInfo_2
object
Encryption At Rest specification for the Universe. Part of UniverseInfo.
1 property
UniverseEditEncryptionInTransit_2
object
UniverseEditEncryptionInTransit Request Payload to enable or disable encryption in transit. Encryption in transit can be toggled for either node to node traffi…
KubernetesResourceDetails_2
object
Identifies the K8S Resource to operate upon. An internal object used as part of Universe edit operations.
3 properties
YbSoftwareDetails_2
object
YbSoftwareDetails YugabyteDB Software Details object is used to represent the software version of YugabyteDB running on a Universe.
2 properties
UniverseCertRotateSpec_2
object
UniverseCertRotateSpec Request payload to rotate the certs used for encryption in transit. Part of UniverseCertRotateReq.
UniverseSoftwareUpgradePrecheckReq_2
object
UniverseSoftwareUpgradePrecheckReq Payload to precheck a YugabyteDB software upgrade on a Universe. Part of UniverseSoftwareUpgradePrecheckReq
1 property
1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration. Part of QueryLogConfig.
10 properties
9 required
UniverseSoftwareUpgradeFinalize_2
object
UniverseSoftwareUpgradeFinalize Payload to finalize a YugabyteDB software upgrade on a Universe
1 property
NodeFileCollectionResult_2
object
Result of collecting files from a single node
11 properties
7 required
UniverseInfo_2
object
These are read-only system generated properties of a Universe. Returned as part of a Universe resource.
34 properties
PlacementAZ_2
object
YBA Placement Availability Zone within Placement Region. Part of PlacementRegion.
9 properties
4 required
ClusterResizeStorageSpec_2
object
Storage volume specification that is used for tserver nodes in this cluster. Part of ClusterSpec, ClusterAddSpec and ClusterEditSpec.
3 properties
UniverseSoftwareFinalizeImpactedXCluster_2
object
ImpactedXClusterInfo XCluster info that are impacted by software upgrade. Part of SoftwareUpgradesFinalize schema.
3 properties
3 required
ClusterProviderEditSpec_2
object
Edit Cloud Provider settings for the cluster. Part of ClusterAddSpec and ClusterEditSpec.
1 property
1 required
PlacementCloud_2
object
YBA Placement Cloud. Part of ClusterPlacementSpec.
5 properties
3 required
PlacementRegion_2
object
YBA Placement Region. Part of PlacementCloud.
5 properties
3 required
UniverseResourceDetails_2
object
Universe resource details. Part of UniverseInfo.
11 properties
1 required
QueryLogConfig_2
object
Query Log Configuration Specification for the Universe. Part of Clusterspec.
3 properties
1 required
ClusterProviderSpec_2
object
Cloud Provider settings for the cluster. Part of ClusterSpec.
8 properties
1 required
UniverseResumeCanaryUpgrade_2
object
UniverseResumeCanaryUpgrade Payload to resume a paused canary software upgrade on a Universe.
1 property
1 required
MetricsTelemetrySpec_2
Metrics export. Omit or set to null to disable.
UserInfo_2
object
System generated properties of a User. Part of User.
7 properties
UniverseExporterConfig_2
object
UniverseExporterConfig Universe Exporter Config. Base configuration for exporters in the Universe. Used for AuditLogConfig, QueryLogConfig, MetricsExportConfig.
2 properties
1 required
UniverseResizeNodesCluster_2
object
UniverseResizeNodesCluster A single cluster for UniverseResizeNodes.
3 properties
2 required
AvailabilityZoneGFlags_2
object
GFlags for tserver and master. Part of ClusterGFlags.
2 properties
YSQLAuditConfig_2
object
YSQL Audit Logging Configuration. Part of AuditLogConfig.
11 properties
11 required
UniverseThirdPartySoftwareUpgradeStart_2
UniverseThirdPartyUpgradeStart Payload to start a third party software upgrade on a Universe. Part of UniverseThirdPartyUpgradeReq
UniverseOperatorImportReq_2
object
UniverseOperatorImportReq Payload to import a universe to the operator. Part of UniverseOperatorImportReq
1 property
UniverseUpgradeOptionsAll_2
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
ClusterPlacementSpec_2
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
UniverseListApiFilter_2
object
Optional filter for listing universes. Matches V1 GET /api/customers/{id}/universes?name=... behavior (exact name match).
1 property
ClusterResizeNodeSpec_2
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…
CollectFilesResponse_2
object
Response from collecting files from database nodes
2 properties
2 required
CloudVolumeEncryption_2
object
Volume encryption settings for cloud volumes (currently AWS EBS volumes only)
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YugabyteDB 12
Other APIs YugabyteDB publishes across the network.
YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
#Universe