YugabyteDB Universe Upgrades Management API

The Universe Upgrades Management API from YugabyteDB — 20 operation(s) for universe upgrades management.

Operations 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 #

Documentation

Specifications

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/yugabytedb-universe-upgrades-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yugabytedb-universe-upgrades-management-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Yugabytedb Universe Upgrades Management API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Universe Upgrades Management across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Universe Upgrades Management
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/audit_log_config:
    post:
      description: 'WARNING: This is a preview API that could change. Modifies the audit logging configuration for a universe.'
      operationId: modifyAuditLogging
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditLogConfigParams'
        description: Audit Logging Configuration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Modify Audit Logging Configuration
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: auditLoggingConfig
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/certs:
    post:
      description: Queues a task to perform certificate rotation and rolling restart in a universe.
      operationId: upgradeCerts
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertsRotateParams'
        description: Certs Rotate Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade Certs
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: certs_rotate_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/db_version:
    post:
      description: 'WARNING: This is a preview API that could change. This is a two step DB software version upgrade, Upgrade DB version and then finalize software which would be same as of upgrade software but additionally support rollback before upgrade finalize. '
      operationId: upgradeDBVersion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SoftwareUpgradeParams'
        description: Software Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade DB version
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: software_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize:
    post:
      description: 'WARNING: This is a preview API that could change. Queues a task to finalize upgrade in a universe.'
      operationId: finalizeUpgrade
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinalizeUpgradeParams'
        description: Finalize Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Finalize Upgrade
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: finalize_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/finalize/info:
    get:
      description: 'WARNING: This is a preview API that could change. Provides pre-finalize software upgrade info.'
      operationId: preFinalizeSoftwareUpgradeInfo
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinalizeUpgradeInfoResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Finalize Software Upgrade info
      tags:
      - Universe Upgrades Management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/gflags:
    post:
      description: Queues a task to perform gflags upgrade and rolling restart in a universe.
      operationId: upgradeGFlags
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GFlagsUpgradeParams'
        description: GFlags Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade GFlags
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: gflags_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/k8s_immutable_ybc:
    post:
      description: 'WARNING: This is a preview API that could change. Queues a task to toggle immutable YBC on Kubernetes universe.'
      operationId: kubernetesToggleImmutableYbc
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KubernetesToggleImmutableYbcParams'
        description: Kubernetes Toggle Immutable Ybc Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade Kubernetes universe to toggle immutable YBC
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: Kubernetes_toggle_immutable_ybc
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/kubernetes_overrides:
    post:
      description: Queues a task to perform Kubernetesoverrides upgrade for a kubernetes universe.
      operationId: upgradeKubernetesOverrides
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KubernetesOverridesUpgradeParams'
        description: Kubernetes Override Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade KubernetesOverrides
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: Kubernetes_overrides_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/provision_nodes:
    post:
      description: Queues a task to provision universe nodes with YBA node agent and YNP stack. Supports rolling upgrade.
      operationId: provisionUniverseNodes
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisionUniverseNodesParams'
        description: Provision Universe Nodes Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Provision universe nodes
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: provision_universe_nodes_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/proxy_config:
    post:
      description: 'WARNING: This is a preview API that could change. Queues a task to perform Proxy config update in the Universe details.'
      operationId: updateProxyConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyConfigUpdateParams'
        description: Update Proxy Config Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update Proxy Config
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: update_proxy_config_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/reboot:
    post:
      description: Queues a task to perform a rolling reboot in a universe.
      operationId: rebootUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpgradeTaskParams'
        description: Upgrade Task Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Reboot universe
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: upgrade_task_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/resize_node:
    post:
      description: 'Queues a task to perform node resize and rolling restart in a universe.<p>This API can be used to change the deviceInfo.volumeSize, masterDeviceInfo.volumeSize,instanceType, masterInstanceType of all the nodes of a Universe simultaneously without moving data from old nodes to new nodes. Refer: https://docs.yugabyte.com/preview/yugabyte-platform/manage-deployments/edit-universe/#smart-resize'
      operationId: resizeNode
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResizeNodeParams'
        description: Resize Node Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Resize Node
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: resize_node_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/restart:
    post:
      description: Queues a task to perform a rolling restart in a universe.
      operationId: restartUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestartTaskParams'
        description: Restart Task Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Restart Universe
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: restart_task_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/rollback:
    post:
      description: 'WARNING: This is a preview API that could change. Queues a task to rollback upgrade in a universe.'
      operationId: rollbackUpgrade
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RollbackUpgradeParams'
        description: RollBack Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Rollback Upgrade
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: rollback_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software:
    post:
      description: Queues a task to perform software upgrade and rolling restart in a universe.
      operationId: upgradeSoftware
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SoftwareUpgradeParams'
        description: Software Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade Software
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: software_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck:
    post:
      description: 'WARNING: This is a preview API that could change. Performs pre-checks and provides pre-upgrade info.'
      operationId: softwareUpgradePreCheck
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SoftwareUpgradeInfoRequest'
        description: Software Upgrade Info Request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SoftwareUpgradeInfoResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Software Upgrade universe pre-check
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: software_upgrade_info_request
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/systemd:
    post:
      description: Queues a task to perform systemd upgrade and rolling restart in a universe.
      operationId: upgradeSystemd
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemdUpgradeParams'
        description: Systemd Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade Systemd
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: systemd_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/thirdparty_software:
    post:
      description: Queues a task to perform upgrade third-party software in a universe.
      operationId: upgradeThirdpartySoftware
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThirdpartySoftwareUpgradeParams'
        description: Thirdparty Software Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade third-party software
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: thirdparty_software_upgrade_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/tls:
    post:
      description: Queues a task to perform TLS ugprade and rolling restart in a universe.
      operationId: upgradeTls
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TlsToggleParams'
        description: TLS Toggle Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade TLS
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: tls_toggle_params
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/upgrade/vm:
    post:
      description: Queues a task to perform VM Image upgrade and rolling restart in a universe.
      operationId: upgradeVMImage
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VMImageUpgradeParams'
        description: VM Image Upgrade Params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Upgrade VM Image
      tags:
      - Universe Upgrades Management
      x-codegen-request-body-name: vmimage_upgrade_params
    servers:
    - url: /
components:
  schemas:
    PlacementRegion:
      example:
        code: code
        azList:
        - replicationFactor: 7
          subnet: subnet
          lbName: lbName
          numNodesInAZ: 4
          name: name
          isAffinitized: true
          leaderPreference: 2
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          secondarySubnet: secondarySubnet
        - replicationFactor: 7
          subnet: subnet
          lbName: lbName
          numNodesInAZ: 4
          name: name
          isAffinitized: true
          leaderPreference: 2
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          secondarySubnet: secondarySubnet
        name: name
        lbFQDN: lbFQDN
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        azList:
          items:
            $ref: '#/components/schemas/PlacementAZ'
          type: array
        code:
          type: string
        lbFQDN:
          type: string
        name:
          type: string
        uuid:
          format: uuid
          type: string
      type: object
    AuditLogConfigParams:
      example:
        additionalServicesStateData:
          earlyoomConfig:
            availMemoryKillPercent: 5
            reportInterval: 9
            preferPattern: preferPattern
            availMemoryKillKb: 5
            availMemoryTermKb: 2
            availMemoryTermPercent: 7
          earlyoomEnabled: true
        expectedUniverseVersion: 0
        universeDetached: true
        sourceXClusterConfigs:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        nodeExporterUser: nodeExporterUser
        placementModificationTaskUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        skipNodeChecks: true
        upgradeOption: Rolling
        auditLogConfig:
          universeLogsExporterConfig:
          - additionalTags:
              key: additionalTags
            exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - additionalTags:
              key: additionalTags
            exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ysqlAuditConfig:
            logRows: true
            logClient: true
            logLevel: DEBUG1
            classes:
            - READ
            - READ
            logStatementOnce: true
            logRelation: true
            logStatement: true
            logCatalog: true
            logParameter: true
            enabled: true
            logParameterMaxSize: 1
          ycqlAuditConfig:
            includedKeyspaces:
            - includedKeyspaces
            - includedKeyspaces
            excludedUsers:
            - excludedUsers
            - excludedUsers
            logLevel: INFO
            includedCategories:
            - QUERY
            - QUERY
            includedUsers:
            - includedUsers
            - includedUsers
            excludedKeyspaces:
            - excludedKeyspaces
            - excludedKeyspaces
            enabled: true
            excludedCategories:
            - QUERY
            - QUERY
          exportActive: true
        rootCA: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        nodesResizeAvailable: true
        softwareUpgradeState: Ready
        updatingTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        allowInsecure: true
        sleepAfterTServerRestartMillis: 5
        installOtelCollector: true
        universePaused: true
        updateSucceeded: true
        installNodeAgent: true
        prevYBSoftwareConfig:
          allTserversUpgradedToYsqlMajorVersion: true
          autoFlagConfigVersion: 3
          canRollbackCatalogUpgrade: true
          targetUpgradeSoftwareVersion: targetUpgradeSoftwareVersion
          softwareVersion: softwareVersion
        useNewHelmNamingStyle: true
        otelCollectorEnabled: true
        updateInProgress: true
        autoRollbackPerformed: true
        targetXClusterConfigs:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        deviceInfo:
          cloudVolumeEncryption:
            enableVolumeEncryption: true
            kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          diskIops: 6
          storageClass: storageClass
          numVolumes: 7
          mountPoints: mountPoints
          storageType: IO1
          throughput: 1
          volumeSize: 4
        enableYbc: true
        updatingTask: CloudBootstrap
        nodeDetailsSet:
        - nodeName: nodeName
          nodeExporterPort: 3
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 3
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 2
          masterState: ToStart
          tserverRpcPort: 6
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 0
          otelCollectorMetricsPort: 1
          isMaster: true
          sshUserOverride: sshUserOverride
          cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          sshPortOverride: 6
          cronsActive: true
          state: Provisioned
          nodeIdx: 6
          masterRpcPort: 6
          redisServerRpcPort: 6
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          tserverHttpPort: 5
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 8
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 3
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          masterHttpPort: 9
          ysqlServerRpcPort: 6
          autoSyncMasterAddrs: true
          yqlServerHttpPort: 7
        - nodeName: nodeName
          nodeExporterPort: 3
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 3
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 2
          masterState: ToStart
          tserverRpcPort: 6
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 0
          otelCollectorMetricsPort: 1
          isMaster: true
          sshUserOverride: sshUserOverride
          cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          sshPortOverride: 6
          cronsActive: true
          state: Provisioned
          nodeIdx: 6
          masterRpcPort: 6
          redisServerRpcPort: 6
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          tserverHttpPort: 5
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 8
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 3
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
     

# --- truncated at 32 KB (11562 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-universe-upgrades-management-api-openapi.yml