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.
The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are VMImageUpgradeParams (74 properties), ResizeNodeParams (71 properties), SoftwareUpgradeParams (71 properties), AuditLogConfigParams (70 properties). Each schema is shown below with its type and property counts.
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties11 required
K8SNodeResourceSpec
object
2 properties2 required
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties1 required
PlacementRegion
object
5 properties
PerProcessDetails
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
AZUpgradeStep
object
AZ upgrade step: order is list order; pauseAfterTserverUpgrade controls canary pause after this AZ
2 properties1 required
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
AuditLogConfigParams
object
70 properties9 required
KubernetesToggleImmutableYbcParams
object
69 properties8 required
RegionDetails
object
1 property
PlacementInfo
object
1 property1 required
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties2 required
AWSRegionCloudInfo
object
4 properties
AzureRegionCloudInfo
object
5 properties
ExtraDependencies
object
Extra dependencies
1 property
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
CanaryUpgradeConfig
object
Canary upgrade configuration
3 properties
ProvisionUniverseNodesParams
object
69 properties7 required
ProxyConfigUpdateParams
object
68 properties7 required
CommunicationPorts
object
Communication ports
15 properties
QueryLogConfig
object
Query Log Configuration
3 properties1 required
AvailabilityZoneDetails
object
1 property
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
YBPTask
object
2 properties
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties9 required
PrevYBSoftwareConfig
object
5 properties
KubernetesRegionInfo
object
22 properties1 required
MetricsExportConfig
object
Metrics Export Configuration
5 properties1 required
GFlagsUpgradeParams
object
70 properties9 required
CertsRotateParams
object
70 properties9 required
GCPRegionCloudInfo
object
2 properties
UpgradeTaskParams
object
68 properties7 required
ImageBundleUpgradeInfo
object
2 properties2 required
ResizeNodeParams
object
71 properties10 required
SoftwareUpgradeParams
object
71 properties9 required
PlacementCloud
object
4 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
RegionCloudInfo
object
4 properties
SystemdUpgradeParams
object
68 properties7 required
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties8 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
EarlyoomConfig
object
State for earlyoom service
6 properties
XClusterInfo
object
1 property
RestartTaskParams
object
68 properties7 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties2 required
DeviceInfo
object
Device information
8 properties
AZCloudInfo
object
1 property
AdditionalServicesStateData
object
Additional services state
2 properties
FinalizeUpgradeInfoResponse
object
Finalize Upgrade Info Response
1 property
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties1 required
ImpactedXClusterConnectedUniverse
object
3 properties
Cluster
object
7 properties2 required
FinalizeUpgradeParams
object
69 properties8 required
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties2 required
UserIntent
object
55 properties
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
SoftwareUpgradeInfoResponse
object
Software Upgrade Info response
2 properties
TlsToggleParams
object
70 properties9 required
KubernetesOverridesUpgradeParams
object
70 properties9 required
PerProcessFlags
object
1 property1 required
NodeDetails
object
Details of a cloud node
37 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
ThirdpartySoftwareUpgradeParams
object
69 properties8 required
VMImageUpgradeParams
object
74 properties9 required
AuditLogConfig
object
Audit Log Configuration
4 properties1 required
PlacementAZ
object
9 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
SoftwareUpgradeInfoRequest
object
Software upgrade info request
1 property1 required
Users
object
A user associated with a customer
12 properties3 required
RollbackUpgradeParams
object
69 properties7 required
PlacementRegion_2
object
4 properties
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties1 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
PlacementInfo_2
object
1 property1 required
ExtraDependencies_2
object
Extra dependencies
1 property
CommunicationPorts_2
object
Communication ports
11 properties
YBPTask_2
object
2 properties
ResizeNodeParams_2
object
42 properties6 required
GFlagsUpgradeParams_2
object
43 properties7 required
CertsRotateParams_2
object
43 properties10 required
UpgradeTaskParams_2
object
41 properties5 required
SoftwareUpgradeParams_2
object
42 properties6 required
PlacementCloud_2
object
4 properties
SystemdUpgradeParams_2
object
41 properties5 required
DeviceInfo_2
object
Device information
7 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties1 required
Cluster_2
object
6 properties2 required
UserIntent_2
object
32 properties
TlsToggleParams_2
object
43 properties11 required
NodeDetails_2
object
Details of a cloud node
28 properties
VMImageUpgradeParams_2
object
44 properties8 required
ThirdpartySoftwareUpgradeParams_2
object
42 properties6 required
PlacementAZ_2
object
7 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 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.
