YugabyteDB Universe management API

The Universe management API from YugabyteDB — 11 operation(s) for universe management.

Operations 12

GET /api/v1/customers/{cUUID}/universes List universes #
DELETE /api/v1/customers/{cUUID}/universes/{uniUUID} Delete a universe #
GET /api/v1/customers/{cUUID}/universes/{uniUUID} Get a universe #
POST /api/v1/customers/{cUUID}/universes/{uniUUID}/config_alerts Configure alerts for a universe #
PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible Flag a universe as Helm 3-compatible - deprecated #
POST /api/v1/customers/{cUUID}/universes/{uniUUID}/pause Pause a universe #
POST /api/v1/customers/{cUUID}/universes/{uniUUID}/resume Resume a paused universe #
POST /api/v1/customers/{cUUID}/universes/{uniUUID}/set_key Set a universe's key #
PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/setup_universe_2dc Reset universe version #
PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state Set a universe's backup flag #
PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config Update load balancer config #
POST /api/v1/customers/{cUUID}/universes/{uniUUID}/toggle_tls Toggle a universe's TLS state #

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-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-management-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Yugabytedb Universe 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 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 management
paths:
  /api/v1/customers/{cUUID}/universes:
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: listUniverses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: name
        schema:
          default: 'null'
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/UniverseResp'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List universes
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}:
    delete:
      description: Available since YBA version 2.2.0.0.
      operationId: deleteUniverse
      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: isForceDelete
        schema:
          default: false
          type: boolean
      - in: query
        name: isDeleteBackups
        schema:
          default: false
          type: boolean
      - in: query
        name: isDeleteAssociatedCerts
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a universe
      tags:
      - Universe management
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: getUniverse
      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/UniverseResp'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a universe
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/config_alerts:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.5.0.</b> Deprcated since YBA version 2.20.5.0. Use 'Create maintenance window' API instead.
      operationId: configureUniverseAlerts
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Configure alerts for a universe
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible:
    put:
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>
      operationId: setUniverseHelm3Compatible
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Flag a universe as Helm 3-compatible - deprecated
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/pause:
    post:
      description: Available since YBA version 2.6.0.0.
      operationId: pauseUniverse
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Pause a universe
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/resume:
    post:
      description: Available since YBA version 2.6.0.0.
      operationId: resumeUniverse
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Resume a paused universe
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/set_key:
    post:
      description: Available since YBA version 2.2.0.0.
      operationId: setUniverseKey
      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/EncryptionAtRestConfig'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniverseResp'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set a universe's key
      tags:
      - Universe management
      x-codegen-request-body-name: SetUniverseKeyRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/setup_universe_2dc:
    put:
      description: YbaApi Internal.
      operationId: resetUniverseVersion
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Reset universe version
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state:
    put:
      description: Available since YBA version 2.2.0.0.
      operationId: setUniverseBackupFlag
      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: markActive
        schema:
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set a universe's backup flag
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config:
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateLoadBalancerConfig
      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: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLoadBalancerConfig'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update load balancer config
      tags:
      - Universe management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/toggle_tls:
    post:
      deprecated: true
      description: Enable or disable node-to-node and client-to-node encryption. Supports rolling and non-rolling universe upgrades.
      operationId: toggleUniverseTLS
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: uniUUID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UniverseResp_2'
      security:
      - apiKeyAuth: []
      summary: Toggle a universe's TLS state
      tags:
      - Universe management
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
    PerProcessFlags:
      example:
        value:
          key:
            key: value
      properties:
        value:
          additionalProperties:
            additionalProperties:
              type: string
            type: object
          type: object
      required:
      - value
      type: object
    AuditLogConfig:
      description: Audit Log Configuration
      example:
        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
      properties:
        exportActive:
          description: Universe logs export active
          type: boolean
        universeLogsExporterConfig:
          description: Universe logs exporter config
          items:
            $ref: '#/components/schemas/UniverseLogsExporterConfig'
          type: array
        ycqlAuditConfig:
          $ref: '#/components/schemas/YCQLAuditConfig'
        ysqlAuditConfig:
          $ref: '#/components/schemas/YSQLAuditConfig'
      required:
      - universeLogsExporterConfig
      type: object
    CloudVolumeEncryption:
      description: Volume encryption settings for AWS EBS volumes
      example:
        enableVolumeEncryption: true
        kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        enableVolumeEncryption:
          description: To enable volume encryption or not
          type: boolean
        kmsConfigUUID:
          description: KMS config UUID to be used for volume encryption
          format: uuid
          type: string
      type: object
    AWSRegionCloudInfo:
      example:
        securityGroupId: securityGroupId
        vnet: vnet
        ybImage: ybImage
        arch: x86_64
      properties:
        arch:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          enum:
          - x86_64
          - aarch64
          type: string
        securityGroupId:
          type: string
        vnet:
          type: string
        ybImage:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          type: string
      type: object
    YCQLAuditConfig:
      description: YCQL Audit Logging Configuration
      example:
        includedKeyspaces:
        - includedKeyspaces
        - includedKeyspaces
        excludedUsers:
        - excludedUsers
        - excludedUsers
        logLevel: INFO
        includedCategories:
        - QUERY
        - QUERY
        includedUsers:
        - includedUsers
        - includedUsers
        excludedKeyspaces:
        - excludedKeyspaces
        - excludedKeyspaces
        enabled: true
        excludedCategories:
        - QUERY
        - QUERY
      properties:
        enabled:
          description: Enabled
          type: boolean
        excludedCategories:
          description: Excluded Categories
          items:
            enum:
            - QUERY
            - DML
            - DDL
            - DCL
            - AUTH
            - PREPARE
            - ERROR
            - OTHER
            type: string
          type: array
          uniqueItems: true
        excludedKeyspaces:
          description: Excluded Keyspaces
          items:
            type: string
          type: array
          uniqueItems: true
        excludedUsers:
          description: Excluded Users
          items:
            type: string
          type: array
          uniqueItems: true
        includedCategories:
          description: Included categories
          items:
            enum:
            - QUERY
            - DML
            - DDL
            - DCL
            - AUTH
            - PREPARE
            - ERROR
            - OTHER
            type: string
          type: array
          uniqueItems: true
        includedKeyspaces:
          description: Included Keyspaces
          items:
            type: string
          type: array
          uniqueItems: true
        includedUsers:
          description: Included Users
          items:
            type: string
          type: array
          uniqueItems: true
        logLevel:
          description: Log Level
          enum:
          - INFO
          - WARNING
          - ERROR
          type: string
      required:
      - enabled
      - excludedCategories
      - excludedKeyspaces
      - excludedUsers
      - includedCategories
      - includedKeyspaces
      - includedUsers
      - logLevel
      type: object
    Users:
      description: A user associated with a customer
      example:
        ldapSpecifiedRole: true
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        role: Admin
        authTokenIssueDate: 2021-06-17 15:00:05+00:00
        timezone: timezone
        oidcJwtAuthToken: oidcJwtAuthToken
        groupMemberships:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        userType: local
        creationDate: 2022-12-12 13:07:18+00:00
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        email: username1@example.com
        primary: true
      properties:
        authTokenIssueDate:
          description: UI session token creation date
          example: 2021-06-17 15:00:05+00:00
          format: date-time
          readOnly: true
          type: string
        creationDate:
          description: User creation date
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        email:
          description: User email address
          example: username1@example.com
          type: string
        groupMemberships:
          items:
            format: uuid
            type: string
          type: array
          uniqueItems: true
        ldapSpecifiedRole:
          description: LDAP Specified Role
          type: boolean
        oidcJwtAuthToken:
          readOnly: true
          type: string
        primary:
          type: boolean
        role:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.19.3.0.</b> Use  getRoleBindings instead.
          enum:
          - ConnectOnly
          - ReadOnly
          - BackupAdmin
          - Admin
          - SuperAdmin
          example: Admin
          type: string
        timezone:
          description: User timezone
          type: string
        userType:
          description: User Type
          enum:
          - local
          - ldap
          - oidc
          type: string
        uuid:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
      required:
      - email
      - groupMemberships
      - primary
      type: object
    UniverseDefinitionTaskParamsResp:
      example:
        additionalServicesStateData:
          earlyoomConfig:
            availMemoryKillPercent: 5
            reportInterval: 9
            preferPattern: preferPattern
            availMemoryKillKb: 5
            availMemoryTermKb: 2
            availMemoryTermPercent: 7
          earlyoomEnabled: true
        expectedUniverseVersion: 3
        universeDetached: true
        sourceXClusterConfigs:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        nodeExporterUser: nodeExporterUser
        placementModificationTaskUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        rootCA: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        nodesResizeAvailable: true
        softwareUpgradeState: Ready
        updatingTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        allowInsecure: true
        sleepAfterTServerRestartMillis: 5
        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: 6
          allowedActions:
          - ADD
          - ADD
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 6
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 3
          masterState: ToStart
          tserverRpcPort: 7
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 8
          otelCollectorMetricsPort: 6
          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: 7
          cronsActive: true
          state: Provisioned
          nodeIdx: 5
          masterRpcPort: 6
          redisServerRpcPort: 3
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          kubernetesOverrides: kubernetesOverrides
          tserverHttpPort: 0
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 1
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 0
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          masterHttpPort: 2
          ysqlServerRpcPort: 3
          autoSyncMasterAddrs: true
          yqlServerHttpPort: 4
        - nodeName: nodeName
          nodeExporterPort: 6
          allowedActions:
          - ADD
          - ADD
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 6
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 3
          masterState: ToStart
          tserverRpcPort: 7
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 8
          otelCollectorMetricsPort: 6
          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: 7
          cronsActive: true
          state: Provisioned
          nodeIdx: 5
          masterRpcPort: 6
          redisServerRpcPort: 3
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          kubernetesOverrides: kubernetesOverrides
          tserverHttpPort: 0
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 1
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 0
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          masterHttpPort: 2
          ysqlServerRpcPort: 3
          autoSyncMasterAddrs: true
          yqlServerHttpPort: 4
        remotePackagePath: remotePackagePath
        ybcInstalled: true
        communicationPorts:
          nodeExporterPort: 5
          tserverHttpPort: 9
          internalYsqlServerRpcPort: 0
          ybControllerHttpPort: 2
          redisServerHttpPort: 2
          ybControllerrRpcPort: 4
          tserverRpcPort: 3
          ysqlServerHttpPort: 1
          yqlServerRpcPort: 1
          masterHttpPort: 6
          otelCollectorMetricsPort: 5
          ysqlServerRpcPort: 1
          yqlServerHttpPort: 7
          masterRpcPort: 1
          redisServerRpcPort: 7
        rootAndClientRootCASame: true
        sleepAfterMasterRestartMillis: 7
        resetAZConfig: true
        userAZSelected: true
        fipsEnabled: true
        encryptionAtRestConfig:
          encryptionAtRestEnabled: true
          opType: ENABLE
          kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          type: CMK
        updateOptions:
        - UPDATE
        - UPDATE
        nodePrefix: nodePrefix
        itestS3PackagePath: itestS3PackagePath
        capability: READ_ONLY
        ybcSoftwareVersion: ybcSoftwareVersion
        creatingUser:
          ldapSpecifiedRole: true
          customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          role: Admin
          authTokenIssueDate: 2021-06-17 15:00:05+00:00
          timezone: timezone
          oidcJwtAuthToken: oidcJwtAuthToken
          groupMemberships:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          userType: local
          creationDate: 2022-12-12 13:07:18+00:00
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          email: username1@example.com
          primary: true
        extraDependencies:
          installNodeExporter: true
        sshUserOverride: sshUserOverride
        platformVersion: platformVersion
        clusters:
        - partitions:
          - replicationFactor: 1
            defaultPartition: true
            name: name
            placement:
              cloudList:
              - code: code
                regionList:
                - 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
                - 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
                defaultRegion: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
              - code: code
                regionList:
                - 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
                - 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
                defaultRegion: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            uuid: 046b6c7f

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