YugabyteDB Universe Upgrades Management API
The Universe Upgrades Management API from YugabyteDB — 20 operation(s) for universe upgrades management.
YugabyteDB Universe Upgrades Management 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 Upgrades 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 20 operations across 20 paths, and defines 136 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.
20 operations
20 paths
136 schemas
1 GET19 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Universe Upgrades Management 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 20
Across 20 paths, the API surfaces 20 operations — 1 GET, 19 POST. Each is listed below with its method, path, parameters, and response codes.
Universe Upgrades Management 20
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/audit_log_config
YugabyteDB Anywhere Modify Audit Logging Configuration
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/certs
YugabyteDB Anywhere Upgrade Certs
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/db_version
YugabyteDB Anywhere Upgrade DB Version
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize
YugabyteDB Anywhere Finalize Upgrade
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize/info
YugabyteDB Anywhere Finalize Software Upgrade Info
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/gflags
YugabyteDB Anywhere Upgrade GFlags
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/k8s_immutable_ybc
YugabyteDB Anywhere Upgrade Kubernetes Universe to Toggle Immutable YBC
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/kubernetes_overrides
YugabyteDB Anywhere Upgrade KubernetesOverrides
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/provision_nodes
YugabyteDB Anywhere Provision Universe Nodes
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/proxy_config
YugabyteDB Anywhere Update Proxy Config
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/reboot
YugabyteDB Anywhere Reboot Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/resize_node
YugabyteDB Anywhere Resize Node
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/restart
YugabyteDB Anywhere Restart Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rollback
YugabyteDB Anywhere Rollback Upgrade
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software
YugabyteDB Anywhere Upgrade Software
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck
YugabyteDB Anywhere Software Upgrade Universe Pre-check
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/systemd
YugabyteDB Anywhere Upgrade Systemd
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/thirdparty_software
YugabyteDB Anywhere Upgrade Third-party Software
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/tls
YugabyteDB Anywhere Upgrade TLS
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/vm
YugabyteDB Anywhere Upgrade VM Image
Schemas 136
The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are VMImageUpgradeParams (74 properties), VMImageUpgradeParams_2 (74 properties), ResizeNodeParams (71 properties), SoftwareUpgradeParams_2 (71 properties). Each schema is shown below with its type and property counts.
AZUpgradeStep
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties
1 required
SoftwareUpgradeParams
object
71 properties
9 required
QueryLogConfig
object
Query Log Configuration
3 properties
1 required
NodeDetails
object
Details of a cloud node
37 properties
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties
1 required
FinalizeUpgradeParams
object
69 properties
8 required
EarlyoomConfig
object
State for earlyoom service
6 properties
MetricsExportConfig
object
Metrics Export Configuration
5 properties
1 required
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties
2 required
ImpactedXClusterConnectedUniverse
object
3 properties
AZCloudInfo
object
1 property
SoftwareUpgradeInfoResponse
object
Software Upgrade Info response
2 properties
YBPTask
object
2 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
KubernetesToggleImmutableYbcParams
object
69 properties
8 required
RollMaxBatchSize
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AWSRegionCloudInfo
object
4 properties
GFlagsUpgradeParams
object
70 properties
9 required
RegionDetails
object
1 property
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties
8 required
CanaryUpgradeConfig
object
Canary upgrade configuration
3 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
AvailabilityZoneDetails
object
1 property
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties
11 required
Cluster
object
7 properties
2 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties
2 required
VMImageUpgradeParams
object
74 properties
9 required
AdditionalServicesStateData
object
Additional services state
2 properties
TlsToggleParams
object
70 properties
9 required
AzureRegionCloudInfo
object
5 properties
KubernetesOverridesUpgradeParams
object
70 properties
9 required
PrevYBSoftwareConfig
object
5 properties
AuditLogConfig
object
Audit Log Configuration
4 properties
1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties
9 required
ThirdpartySoftwareUpgradeParams
object
69 properties
8 required
ExtraDependencies
object
Extra dependencies
1 property
UpgradeTaskParams
object
68 properties
7 required
SystemdUpgradeParams
object
68 properties
7 required
ProvisionUniverseNodesParams
object
69 properties
7 required
SoftwareUpgradeInfoRequest
object
Software upgrade info request
1 property
1 required
CertsRotateParams
object
70 properties
9 required
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo
object
2 properties
PlacementAZ
object
9 properties
Users
object
A user associated with a customer
12 properties
3 required
ProxyConfigUpdateParams
object
68 properties
7 required
FinalizeUpgradeInfoResponse
object
Finalize Upgrade Info Response
1 property
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties
2 required
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
DeviceInfo
object
Device information
8 properties
K8SNodeResourceSpec
object
2 properties
2 required
AuditLogConfigParams
object
70 properties
9 required
ResizeNodeParams
object
71 properties
10 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
UserIntent
object
55 properties
RestartTaskParams
object
68 properties
7 required
RollbackUpgradeParams
object
69 properties
7 required
UserIntentOverrides
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
PerProcessFlags
object
1 property
1 required
ImageBundleUpgradeInfo
object
2 properties
2 required
CommunicationPorts
object
Communication ports
15 properties
PlacementCloud
object
4 properties
XClusterInfo
object
1 property
ProxyConfig
object
The Proxy Settings for the Universe
3 properties
PlacementRegion
object
5 properties
KubernetesRegionInfo
object
22 properties
1 required
RegionCloudInfo
object
4 properties
PlacementInfo
object
1 property
1 required
AZUpgradeStep_2
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties
1 required
SoftwareUpgradeParams_2
object
71 properties
9 required
QueryLogConfig_2
object
Query Log Configuration
3 properties
1 required
NodeDetails_2
object
Details of a cloud node
37 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
9 properties
1 required
FinalizeUpgradeParams_2
object
69 properties
8 required
EarlyoomConfig_2
object
State for earlyoom service
6 properties
MetricsExportConfig_2
object
Metrics Export Configuration
5 properties
1 required
UniverseQueryLogsExporterConfig_2
object
Universe Logs Exporter Config
7 properties
2 required
ImpactedXClusterConnectedUniverse_2
object
3 properties
SoftwareUpgradeInfoResponse_2
object
Software Upgrade Info response
2 properties
YBPTask_2
object
2 properties
SpecificGFlags_2
object
GFlags for current cluster
4 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
KubernetesToggleImmutableYbcParams_2
object
69 properties
8 required
RollMaxBatchSize_2
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AWSRegionCloudInfo_2
object
4 properties
GFlagsUpgradeParams_2
object
70 properties
9 required
YCQLAuditConfig_2
object
YCQL Audit Logging Configuration
8 properties
8 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties
AZOverrides_2
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
YSQLAuditConfig_2
object
YSQL Audit Logging Configuration
11 properties
11 required
Cluster_2
object
7 properties
2 required
UniverseLogsExporterConfig_2
object
Universe Logs Exporter Config
2 properties
2 required
VMImageUpgradeParams_2
object
74 properties
9 required
AdditionalServicesStateData_2
object
Additional services state
2 properties
TlsToggleParams_2
object
70 properties
9 required
AzureRegionCloudInfo_2
object
5 properties
KubernetesOverridesUpgradeParams_2
object
70 properties
9 required
PrevYBSoftwareConfig_2
object
5 properties
AuditLogConfig_2
object
Audit Log Configuration
4 properties
1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration
10 properties
9 required
ThirdpartySoftwareUpgradeParams_2
object
69 properties
8 required
ExtraDependencies_2
object
Extra dependencies
1 property
UpgradeTaskParams_2
object
68 properties
7 required
SystemdUpgradeParams_2
object
68 properties
7 required
ProvisionUniverseNodesParams_2
object
69 properties
7 required
SoftwareUpgradeInfoRequest_2
object
Software upgrade info request
1 property
1 required
CertsRotateParams_2
object
70 properties
9 required
PartitionInfo_2
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo_2
object
2 properties
PlacementAZ_2
object
9 properties
Users_2
object
A user associated with a customer
12 properties
3 required
ProxyConfigUpdateParams_2
object
68 properties
7 required
FinalizeUpgradeInfoResponse_2
object
Finalize Upgrade Info Response
1 property
UniverseMetricsExporterConfig_2
object
Metrics Exporter Configuration
8 properties
2 required
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
DeviceInfo_2
object
Device information
8 properties
K8SNodeResourceSpec_2
object
2 properties
2 required
AuditLogConfigParams_2
object
70 properties
9 required
ResizeNodeParams_2
object
71 properties
10 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
UserIntent_2
object
55 properties
RestartTaskParams_2
object
68 properties
7 required
RollbackUpgradeParams_2
object
69 properties
7 required
UserIntentOverrides_2
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
PerProcessFlags_2
object
1 property
1 required
ImageBundleUpgradeInfo_2
object
2 properties
2 required
CommunicationPorts_2
object
Communication ports
15 properties
PlacementCloud_2
object
4 properties
XClusterInfo_2
object
1 property
PlacementRegion_2
object
5 properties
KubernetesRegionInfo_2
object
22 properties
1 required
PlacementInfo_2
object
1 property
1 required
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 Upgrades Management