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 225 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, /.
20 operations
20 paths
225 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.
An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).
apiKeyAuth— API token passed as 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
Modify Audit Logging Configuration
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/certs
Upgrade Certs
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/db_version
Upgrade DB version
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize
Finalize Upgrade
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize/info
Finalize Software Upgrade info
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/gflags
Upgrade GFlags
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/k8s_immutable_ybc
Upgrade Kubernetes universe to toggle immutable YBC
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/kubernetes_overrides
Upgrade KubernetesOverrides
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/provision_nodes
Provision universe nodes
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/proxy_config
Update Proxy Config
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/reboot
Reboot universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/resize_node
Resize Node
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/restart
Restart Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rollback
Rollback Upgrade
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software
Upgrade Software
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck
Software Upgrade universe pre-check
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/systemd
Upgrade Systemd
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/thirdparty_software
Upgrade third-party software
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/tls
Upgrade TLS
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/vm
Upgrade VM Image
Schemas 225
The contract defines 225 schemas that model the data the API accepts and returns. The most detailed are VMImageUpgradeParams (74 properties), VMImageUpgradeParams_3 (74 properties), VMImageUpgradeParams_4 (74 properties), SoftwareUpgradeParams_3 (71 properties). Each schema is shown below with its type and property counts.
PlacementRegion
object
5 properties
AuditLogConfigParams
object
70 properties
9 required
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
SoftwareUpgradeInfoRequest
object
Software upgrade info request
1 property
1 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
KubernetesOverridesUpgradeParams
object
70 properties
9 required
XClusterInfo
object
1 property
AzureRegionCloudInfo
object
5 properties
TlsToggleParams
object
70 properties
9 required
ProvisionUniverseNodesParams
object
69 properties
7 required
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
FinalizeUpgradeParams
object
69 properties
8 required
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
ThirdpartySoftwareUpgradeParams
object
69 properties
8 required
VMImageUpgradeParams
object
74 properties
9 required
KubernetesRegionInfo
object
22 properties
1 required
FinalizeUpgradeInfoResponse
object
Finalize Upgrade Info Response
1 property
ImpactedXClusterConnectedUniverse
object
3 properties
Cluster
object
7 properties
2 required
UpgradeTaskParams
object
68 properties
7 required
ProxyConfigUpdateParams
object
68 properties
7 required
PrevYBSoftwareConfig
object
5 properties
SystemdUpgradeParams
object
68 properties
7 required
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
RollbackUpgradeParams
object
69 properties
7 required
GCPRegionCloudInfo
object
2 properties
RegionCloudInfo
object
4 properties
SoftwareUpgradeParams
object
71 properties
9 required
ResizeNodeParams
object
71 properties
10 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
AvailabilityZoneDetails
object
1 property
UserIntent
object
55 properties
RegionDetails
object
1 property
NodeDetails
object
Details of a cloud node
37 properties
RestartTaskParams
object
68 properties
7 required
AZUpgradeStep
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties
1 required
CanaryUpgradeConfig
object
Canary upgrade configuration
3 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
GFlagsUpgradeParams
object
70 properties
9 required
SoftwareUpgradeInfoResponse
object
Software Upgrade Info response
2 properties
CommunicationPorts
object
Communication ports
15 properties
CertsRotateParams
object
70 properties
9 required
PlacementInfo
object
1 property
1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties
9 required
ImageBundleUpgradeInfo
object
2 properties
2 required
KubernetesToggleImmutableYbcParams
object
69 properties
8 required
YBPTask
object
2 properties
PlacementInfo_2
object
1 property
1 required
ExtraDependencies_2
object
Extra dependencies
1 property
DeviceInfo_2
object
Device information
7 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
TlsToggleParams_2
object
43 properties
11 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
VMImageUpgradeParams_2
object
44 properties
8 required
ThirdpartySoftwareUpgradeParams_2
object
42 properties
6 required
Cluster_2
object
6 properties
2 required
UpgradeTaskParams_2
object
41 properties
5 required
SystemdUpgradeParams_2
object
41 properties
5 required
PlacementAZ_2
object
7 properties
SoftwareUpgradeParams_2
object
42 properties
6 required
ResizeNodeParams_2
object
42 properties
6 required
UserIntent_2
object
32 properties
NodeDetails_2
object
Details of a cloud node
28 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties
1 required
PlacementCloud_2
object
4 properties
GFlagsUpgradeParams_2
object
43 properties
7 required
CommunicationPorts_2
object
Communication ports
11 properties
CertsRotateParams_2
object
43 properties
10 required
PlacementRegion_2
object
4 properties
YBPTask_2
object
2 properties
PlacementRegion_3
object
5 properties
AuditLogConfigParams_2
object
70 properties
9 required
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
SoftwareUpgradeInfoRequest_2
object
Software upgrade info request
1 property
1 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
KubernetesOverridesUpgradeParams_2
object
70 properties
9 required
XClusterInfo_2
object
1 property
AzureRegionCloudInfo_2
object
5 properties
TlsToggleParams_3
object
70 properties
9 required
ProvisionUniverseNodesParams_2
object
69 properties
7 required
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
FinalizeUpgradeParams_2
object
69 properties
8 required
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
ThirdpartySoftwareUpgradeParams_3
object
69 properties
8 required
VMImageUpgradeParams_3
object
74 properties
9 required
KubernetesRegionInfo_2
object
22 properties
1 required
FinalizeUpgradeInfoResponse_2
object
Finalize Upgrade Info Response
1 property
ImpactedXClusterConnectedUniverse_2
object
3 properties
Cluster_3
object
7 properties
2 required
UpgradeTaskParams_3
object
68 properties
7 required
ProxyConfigUpdateParams_2
object
68 properties
7 required
PrevYBSoftwareConfig_2
object
5 properties
SystemdUpgradeParams_3
object
68 properties
7 required
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
RollbackUpgradeParams_2
object
69 properties
7 required
GCPRegionCloudInfo_2
object
2 properties
SoftwareUpgradeParams_3
object
71 properties
9 required
ResizeNodeParams_3
object
71 properties
10 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
UserIntent_3
object
55 properties
NodeDetails_3
object
Details of a cloud node
37 properties
RestartTaskParams_2
object
68 properties
7 required
AZUpgradeStep_2
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties
1 required
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
GFlagsUpgradeParams_3
object
70 properties
9 required
SoftwareUpgradeInfoResponse_2
object
Software Upgrade Info response
2 properties
CommunicationPorts_3
object
Communication ports
15 properties
CertsRotateParams_3
object
70 properties
9 required
PlacementInfo_3
object
1 property
1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration
10 properties
9 required
ImageBundleUpgradeInfo_2
object
2 properties
2 required
KubernetesToggleImmutableYbcParams_2
object
69 properties
8 required
YBPTask_3
object
2 properties
PlacementRegion_4
object
5 properties
AuditLogConfigParams_3
object
70 properties
9 required
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
SoftwareUpgradeInfoRequest_3
object
Software upgrade info request
1 property
1 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
KubernetesOverridesUpgradeParams_3
object
70 properties
9 required
XClusterInfo_3
object
1 property
AzureRegionCloudInfo_3
object
5 properties
TlsToggleParams_4
object
70 properties
9 required
ProvisionUniverseNodesParams_3
object
69 properties
7 required
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
FinalizeUpgradeParams_3
object
69 properties
8 required
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
ThirdpartySoftwareUpgradeParams_4
object
69 properties
8 required
VMImageUpgradeParams_4
object
74 properties
9 required
KubernetesRegionInfo_3
object
22 properties
1 required
FinalizeUpgradeInfoResponse_3
object
Finalize Upgrade Info Response
1 property
ImpactedXClusterConnectedUniverse_3
object
3 properties
Cluster_4
object
7 properties
2 required
UpgradeTaskParams_4
object
68 properties
7 required
ProxyConfigUpdateParams_3
object
68 properties
7 required
PrevYBSoftwareConfig_3
object
5 properties
SystemdUpgradeParams_4
object
68 properties
7 required
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
RollbackUpgradeParams_3
object
69 properties
7 required
GCPRegionCloudInfo_3
object
2 properties
SoftwareUpgradeParams_4
object
71 properties
9 required
ResizeNodeParams_4
object
71 properties
10 required
RollMaxBatchSize_3
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
UserIntent_4
object
55 properties
NodeDetails_4
object
Details of a cloud node
37 properties
RestartTaskParams_3
object
68 properties
7 required
AZUpgradeStep_3
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties
1 required
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
GFlagsUpgradeParams_4
object
70 properties
9 required
SoftwareUpgradeInfoResponse_3
object
Software Upgrade Info response
2 properties
CommunicationPorts_4
object
Communication ports
15 properties
CertsRotateParams_4
object
70 properties
9 required
PlacementInfo_4
object
1 property
1 required
YSQLQueryLogConfig_3
object
YSQL Query Logging Configuration
10 properties
9 required
ImageBundleUpgradeInfo_3
object
2 properties
2 required
KubernetesToggleImmutableYbcParams_3
object
69 properties
8 required
YBPTask_4
object
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 Upgrades Management
Where this information came from
This is an independent, third-party profile of YugabyteDB Universe Upgrades 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.