YugabyteDB Universe API

openapi: 3.2.0
info:
  title: Yugabytedb Universe API
  version: v2
  contact:
    email: support@yugabyte.com
    name: YugabyteDB Anywhere Support
    url: 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
  description: 'Operations tagged Universe across 2 of this provider''s published API definitions: openapi.yaml, yugabytedb-anywhere-v2-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: API endpoint of YBA server
  url: '{protocol}://{host_port}/api/v2'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host_port:
      default: localhost:9000
tags:
- description: CRUD operations for a Universe
  name: Universe
paths:
  /customers/{cUUID}/universes/{uniUUID}:
    delete:
      description: Delete Universe.
      operationId: deleteUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseDeleteReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Delete a universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: Delete
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: DELETE
        resourceLocation:
          path: UNIVERSES
          sourceType: ENDPOINT
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    get:
      description: Get details of a single YugabyteDB Universe.
      operationId: getUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Universe'
          description: success
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Get a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: READ
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
    put:
      description: Edit the clusters of a single YugabyteDB Universe.
      operationId: editUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseEditReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Edit a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: Update
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: UNIVERSES
          sourceType: ENDPOINT
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes:
    post:
      description: Create all the clusters of a YugabyteDB universe.
      operationId: createUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseCreateReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Create a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: obj.getResourceUuid().toString()
        auditActionType: CreateCluster
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: CREATE
        resourceLocation:
          path: UNIVERSE_UUID
          sourceType: REQUEST_BODY
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/page:
    post:
      description: 'Returns universes for the specified customer

        WARNING: This is a preview API that could change.

        '
      operationId: pageListUniverses
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniversePagedReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniversePagedResp'
          description: Universes visible to the caller for this page
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: List universes
      tags:
      - Universe
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: READ
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: true
      x-yba-api-since: 2026.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/clusters:
    post:
      description: Add a cluster (eg. read replica cluster) to a YugabyteDB universe.
      operationId: addCluster
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/ClusterAddReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Add a cluster to a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: CreateReadOnlyCluster
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: UNIVERSES
          sourceType: ENDPOINT
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/clusters/{clsUUID}:
    delete:
      description: Delete an additional cluster (eg. read replica cluster) of a YugabyteDB universe. Primary cluster is deleted along with Universe.
      operationId: deleteCluster
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Cluster UUID
        explode: false
        in: path
        name: clsUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Whether to force delete the cluster
        explode: true
        in: query
        name: isForceDelete
        required: false
        schema:
          default: false
          type: boolean
        style: form
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Delete an additional cluster(s) of a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: DeleteReadOnlyCluster
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: UNIVERSES
          sourceType: ENDPOINT
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/fetch-universe-resources:
    post:
      description: Fetches an estimate of pricing and cpu/memory/storage resource utilisation for the Universe. This is meant to be used before creating the Universe.
      operationId: getUniverseResources
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseCreateReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniverseResourceDetails'
          description: success
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Get resource utilisation of a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Customer
        auditTargetId: cUUID.toString()
        auditActionType: GetUniverseResources
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: READ
        resourceLocation:
          path: customers
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2025.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/gflags:
    post:
      description: Queues a task to edit GFlags of a universe. The input set of GFlags will replace any existing GFlags in the universe. Refer [YB-Master configuration flags](https://docs.yugabyte.com/preview/reference/configuration/yb-master/#configuration-flags) and [YB-TServer configuration flags](https://docs.yugabyte.com/preview/reference/configuration/yb-tserver/#configuration-flags).
      operationId: editGFlags
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseEditGFlagsReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Edit GFlags
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: UpgradeGFlags
        taskUuid: obj.getTaskUuid()
        additionalDetails: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2.20.2.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/software:
    post:
      description: Queues a task to perform a YugabyteDB Software upgrade.
      operationId: startSoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseSoftwareUpgradeReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Upgrade YugabyteDB version
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: UpgradeSoftware
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize:
    get:
      description: Get finalize info of a YugabyteDB Software upgrade.
      operationId: getFinalizeSoftwareUpgradeInfo
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniverseSoftwareUpgradeFinalizeInfo'
          description: Software Upgrade Finalize information
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Get finalize information on the YugabyteDB upgrade
      tags:
      - Universe
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
    post:
      description: Queues a task to perform finalize of a YugabyteDB Software upgrade.
      operationId: finalizeSoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseSoftwareUpgradeFinalize'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Finalize the Upgrade YugabyteDB
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: UpgradeSoftware
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/third-party-software:
    post:
      description: Queues a task to perform a third party software upgrade.
      operationId: startThirdPartySoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseThirdPartySoftwareUpgradeReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Upgrade third party software
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: ThirdpartySoftwareUpgrade
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/software/rollback:
    post:
      description: Queues a task to rollback a YugabyteDB Software upgrade.
      operationId: rollbackSoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseRollbackUpgradeReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Rollback YugabyteDB version
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: RollbackUpgrade
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/software/resume-canary:
    post:
      description: Queues a task to resume a paused canary software upgrade.
      operationId: resumeCanarySoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseResumeCanaryUpgradeReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Resume canary software upgrade
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: UpgradeSoftware
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2026.1.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck:
    post:
      description: Queues a task to perform a precheck for a YugabyteDB Software upgrade.
      operationId: precheckSoftwareUpgrade
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseSoftwareUpgradePrecheckReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniverseSoftwareUpgradePrecheckResp'
          description: Software Upgrade Precheck success
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Precheck YugabyteDB version upgrade
      tags:
      - Universe
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/restart:
    post:
      description: Restart a YugabyteDB Universe.
      operationId: restartUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      requestBody:
        $ref: '#/components/requestBodies/UniverseRestartReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: Restart a YugabyteDB Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: Restart
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: UPDATE
        resourceLocation:
          path: universes
          sourceType: endpoint
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
    servers:
    - description: API endpoint of YBA server
      url: '{protocol}://{host_port}/api/v2'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        host_port:
          default: localhost:9000
  /customers/{cUUID}/universes/{uniUUID}/systemd:
    post:
      description: 'Use Systemd to control YugabyteDB services for this universe. This is a 1 way migration from

        cron-based service management to systemd, and will involve a rolling restart of the universe.


        This is not supported for on prem manual provisioned universes or kubernetes universes.

        '
      operationId: systemdEnable
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
      - descriptio

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