YugabyteDB UniverseClusterMutations API

openapi: 3.2.0
info:
  title: Yugabytedb Universe Cluster Mutations 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 UniverseClusterMutations 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: UniverseClusterMutations
paths:
  /api/v1/customers/{cUUID}/universes/clusters:
    post:
      description: This will configure and create universe with (optionally) multiple clusters. Just fill in the userIntent for PRIMARY and (optionally) an ASYNC cluster
      operationId: createAllClusters
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UniverseConfigureTaskParams'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create Universe Clusters
      tags:
      - UniverseClusterMutations
      x-codegen-request-body-name: UniverseConfigureTaskParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/primary:
    put:
      description: This will update primary cluster of existing universe.Use API to GET current universe. Lookup universeDetails attribute of the universe resource returned. Update the necessary field (e.g. numNodes) Use this updated universeDetails as request body. See https://github.com/yugabyte/yugabyte-db/blob/master/managed/api-examples/python-simple/edit-universe.ipynb
      operationId: updatePrimaryCluster
      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/UniverseConfigureTaskParams'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update Primary Cluster
      tags:
      - UniverseClusterMutations
      x-codegen-request-body-name: UniverseConfigureTaskParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only:
    post:
      description: This will add a readonly cluster to existing universe. Just fill in the userIntent for ASYNC cluster.
      operationId: createReadOnlyCluster
      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/UniverseDefinitionTaskParams'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create ReadOnly Cluster
      tags:
      - UniverseClusterMutations
      x-codegen-request-body-name: UniverseConfigureTaskParams
    put:
      description: This will update readonly cluster of existing universe.Use API to GET current universe. Lookup universeDetails attribute of the universe resource returned. Update the necessary field (e.g. numNodes) Use this updated universeDetails as request body. See https://github.com/yugabyte/yugabyte-db/blob/master/managed/api-examples/python-simple/edit-universe.ipynb
      operationId: updateReadOnlyCluster
      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/UniverseConfigureTaskParams'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update Readonly Cluster
      tags:
      - UniverseClusterMutations
      x-codegen-request-body-name: UniverseConfigureTaskParams
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/clusters/read_only/{clustUUID}:
    delete:
      description: This will delete readonly cluster of existing universe.
      operationId: deleteReadonlyCluster
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: clustUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: isForceDelete
        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 Readonly Cluster
      tags:
      - UniverseClusterMutations
    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
    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
    UniverseLogsExporterConfig:
      description: Universe Logs Exporter Config
      example:
        additionalTags:
          key: additionalTags
        exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        additionalTags:
          additionalProperties:
            type: string
          description: Additional tags
          type: object
        exporterUuid:
          description: Exporter uuid
          format: uuid
          readOnly: true
          type: string
      required:
      - additionalTags
      - exporterUuid
      type: object
    K8SNodeResourceSpec:
      example:
        memoryGib: 1.1730742509559433
        cpuCoreCount: 7.457744773683766
      properties:
        cpuCoreCount:
          format: double
          type: number
        memoryGib:
          format: double
          type: number
      required:
      - cpuCoreCount
      - memoryGib
      type: object
    YSQLAuditConfig:
      description: YSQL Audit Logging Configuration
      example:
        logRows: true
        logClient: true
        logLevel: DEBUG1
        classes:
        - READ
        - READ
        logStatementOnce: true
        logRelation: true
        logStatement: true
        logCatalog: true
        logParameter: true
        enabled: true
        logParameterMaxSize: 1
      properties:
        classes:
          description: YSQL statement classes
          items:
            enum:
            - READ
            - WRITE
            - FUNCTION
            - ROLE
            - DDL
            - MISC
            - MISC_SET
            type: string
          type: array
          uniqueItems: true
        enabled:
          description: Enabled
          readOnly: true
          type: boolean
        logCatalog:
          description: Log catalog
          type: boolean
        logClient:
          description: Log client
          type: boolean
        logLevel:
          description: Log level. For NOTICE, INFO, DEBUG levels, user also needs to set 'log_min_messages' to the required level for the audit logs to be exported. Default 'log_min_messages' is WARNING.
          enum:
          - DEBUG1
          - DEBUG2
          - DEBUG3
          - DEBUG4
          - DEBUG5
          - INFO
          - NOTICE
          - WARNING
          - LOG
          type: string
        logParameter:
          description: Log parameter
          type: boolean
        logParameterMaxSize:
          description: Log parameter max size
          format: int32
          type: integer
        logRelation:
          description: Log relation
          type: boolean
        logRows:
          description: Log rows
          type: boolean
        logStatement:
          description: Log statement
          type: boolean
        logStatementOnce:
          description: Log statement once
          type: boolean
      required:
      - classes
      - enabled
      - logCatalog
      - logClient
      - logLevel
      - logParameter
      - logParameterMaxSize
      - logRelation
      - logRows
      - logStatement
      - logStatementOnce
      type: object
    ExtraDependencies:
      description: Extra dependencies
      example:
        installNodeExporter: true
      properties:
        installNodeExporter:
          description: Install node exporter on nodes
          type: boolean
      type: object
    UniverseMetricsExporterConfig:
      description: Metrics Exporter Configuration
      example:
        additionalTags:
          key: additionalTags
        sendBatchSize: 100
        sendBatchTimeoutSeconds: 10
        memoryLimitMib: 2048
        exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        memoryLimitCheckIntervalSeconds: 10
        metricsPrefix: ybdb.
        sendBatchMaxSize: 1000
      properties:
        additionalTags:
          additionalProperties:
            type: string
          description: Additional tags
          type: object
        exporterUuid:
          description: Exporter uuid
          format: uuid
          readOnly: true
          type: string
        memoryLimitCheckIntervalSeconds:
          description: Check interval in seconds for the MemoryLimiterProcessor.
          example: 10
          format: int32
          type: integer
        memoryLimitMib:
          description: Memory limit in MiB for the OpenTelemetry Collector process in the config file.
          example: 2048
          format: int32
          type: integer
        metricsPrefix:
          description: Custom prefix to add to all exported metric names. Can be customised to each exporter differently.
          example: ybdb.
          type: string
        sendBatchMaxSize:
          description: Maximum batch size for sending metrics. Can be customised to each exporter differently.
          example: 1000
          format: int32
          type: integer
        sendBatchSize:
          description: Batch size for sending metrics. Can be customised to each exporter differently.
          example: 100
          format: int32
          type: integer
        sendBatchTimeoutSeconds:
          description: Batch timeout in seconds for sending metrics. Can be customised to each exporter differently.
          example: 10
          format: int32
          type: integer
      required:
      - additionalTags
      - exporterUuid
      type: object
    DeviceInfo:
      description: Device information
      example:
        cloudVolumeEncryption:
          enableVolumeEncryption: true
          kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        diskIops: 6
        storageClass: storageClass
        numVolumes: 7
        mountPoints: mountPoints
        storageType: IO1
        throughput: 1
        volumeSize: 4
      properties:
        cloudVolumeEncryption:
          $ref: '#/components/schemas/CloudVolumeEncryption'
        diskIops:
          description: Desired IOPS for the volumes mounted on this instance
          format: int32
          type: integer
        mountPoints:
          description: Comma-separated list of mount points for the devices in each instance
          type: string
        numVolumes:
          description: Number of volumes to be mounted on this instance at the default path
          format: int32
          type: integer
        storageClass:
          description: Name of the storage class
          type: string
        storageType:
          description: Storage type used for this instance
          enum:
          - IO1
          - IO2
          - GP2
          - GP3
          - Scratch
          - Persistent
          - Hyperdisk_Balanced
          - Hyperdisk_Extreme
          - StandardSSD_LRS
          - Premium_LRS
          - PremiumV2_LRS
          - UltraSSD_LRS
          - Local
          type: string
        throughput:
          description: Desired throughput for the volumes mounted on this instance
          format: int32
          type: integer
        volumeSize:
          description: The size of each volume in each instance. Could be modified in payload for /resize_node API call
          format: int32
          type: integer
      type: object
    SpecificGFlags:
      description: GFlags for current cluster
      example:
        inheritFromPrimary: true
        perProcessFlags:
          value:
            key:
              key: value
        gflagGroups: '["ENHANCED_POSTGRES_COMPATIBILITY"]'
        perAZ:
          key:
            value:
              key:
                key: value
      properties:
        gflagGroups:
          description: YbaApi Internal. GFlag groups to be applied
          example: '["ENHANCED_POSTGRES_COMPATIBILITY"]'
          items:
            enum:
            - ENHANCED_POSTGRES_COMPATIBILITY
            type: string
          type: array
        inheritFromPrimary:
          type: boolean
        perAZ:
          additionalProperties:
            $ref: '#/components/schemas/PerProcessFlags'
          description: Overrides for gflags per availability zone
          type: object
        perProcessFlags:
          $ref: '#/components/schemas/PerProcessFlags'
      type: object
    QueryLogConfig:
      description: Query Log Configuration
      example:
        ysqlQueryLogConfig:
          logDuration: true
          logErrorVerbosity: VERBOSE
          logLinePrefix: logLinePrefix
          logMinDurationStatement: 6
          logMinErrorStatement: ERROR
          logStatement: ALL
          logDisconnections: true
          enabled: true
          logConnections: true
          debugPrintPlan: true
        universeLogsExporterConfig:
        - additionalTags:
            key: additionalTags
          sendBatchSize: 9
          sendBatchTimeoutSeconds: 9
          memoryLimitMib: 2048
          exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          memoryLimitCheckIntervalSeconds: 10
          sendBatchMaxSize: 5
        - additionalTags:
            key: additionalTags
          sendBatchSize: 9
          sendBatchTimeoutSeconds: 9
          memoryLimitMib: 2048
          exporterUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          memoryLimitCheckIntervalSeconds: 10
          sendBatchMaxSize: 5
        exportActive: true
      properties:
        exportActive:
          description: Universe logs export active
          type: boolean
        universeLogsExporterConfig:
          description: Universe query logs exporter config
          items:
            $ref: '#/components/schemas/UniverseQueryLogsExporterConfig'
          type: array
        ysqlQueryLogConfig:
          $ref: '#/components/schemas/YSQLQueryLogConfig'
      required:
      - universeLogsExporterConfig
      type: object
    EncryptionAtRestConfig:
      description: Encryption at rest configuration
      example:
        encryptionAtRestEnabled: true
        opType: ENABLE
        kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: CMK
      properties:
        encryptionAtRestEnabled:
          description: Whether a universe is currently encrypted at rest
          type: boolean
        kmsConfigUUID:
          description: KMS configuration UUID
          format: uuid
          type: string
        opType:
          description: 'Operation type: enable, disable, or rotate the universe key/encryption at rest'
          enum:
          - ENABLE
          - DISABLE
          - UNDEFINED
          type: string
        type:
          description: Whether to generate a data key or just retrieve the CMK ARN
          enum:
          - CMK
          - DATA_KEY
          type: string
      type: object
    AzureRegionCloudInfo:
      example:
        securityGroupId: securityGroupId
        vnet: vnet
        ybImage: ybImage
        azuNetworkRGOverride: azuNetworkRGOverride
        azuRGOverride: azuRGOverride
      properties:
        azuNetworkRGOverride:
          type: string
        azuRGOverride:
          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
    XClusterInfo:
      example:
        sourceRootCertDirPath: sourceRootCertDirPath
      properties:
        sourceRootCertDirPath:
          description: The value of certs_for_cdc_dir gflag
          type: string
      type: object
    ProxyConfig:
      description: The Proxy Settings for the Universe
      example:
        httpProxy: http://10.9.131.7:3128
        httpsProxy: http://10.9.131.7:3128
        noProxyList: '["10.150.0.26",".amazonaws.com"]'
      properties:
        httpProxy:
          description: The HTTP_PROXY to use
          example: http://10.9.131.7:3128
          type: string
        httpsProxy:
          description: The HTTPS_PROXY to use
          example: http://10.9.131.7:3128
          type: string
        noProxyList:
          description: The NO_PROXY settings. Should follow cURL no_proxy format
          example: '["10.150.0.26",".amazonaws.com"]'
          items:
            type: string
          type: array
      type: object
    UserIntentOverrides:
      description: 'WARNING: This is a preview API that could change. User Intent overrides'
      example:
        azOverrides:
          key:
            proxyConfig:
              httpProxy: http://10.9.131.7:3128
              httpsProxy: http://10.9.131.7:3128
              noProxyList: '["10.150.0.26",".amazonaws.com"]'
            instanceType: instanceType
            cgroupSize: 6
            deviceInfo:
              cloudVolumeEncryption:
                enableVolumeEncryption: true
                kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
              diskIops: 6
              storageClass: storageClass
              numVolumes: 7
              mountPoints: mountPoints
              storageType: IO1
              throughput: 1
              volumeSize: 4
            perProcess:
              key:
                instanceType: instanceType
                deviceInfo:
                  cloudVolumeEncryption:
                    enableVolumeEncryption: true
                    kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  diskIops: 6
                  storageClass: storageClass
                  numVolumes: 7
                  mountPoints: mountPoints
                  storageType: IO1
                  throughput: 1
                  volumeSize: 4
        perProcess:
          key:
            instanceType: instanceType
            deviceInfo:
              cloudVolumeEncryption:
                enableVolumeEncryption: true
                kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
              diskIops: 6
              storageClass: storageClass
              numVolumes: 7
              mountPoints: mountPoints
              storageType: IO1
              throughput: 1
              volumeSize: 4
      properties:
        azOverrides:
          additionalProperties:
            $ref: '#/components/schemas/AZOverrides'
          type: object
        perProcess:
          additionalProperties:
            $ref: '#/components/schemas/PerProcessDetails'
          type: object
      type: object
    AZCloudInfo:
      example:
        kubernetes:
          kubeNamespace: kubeNamespace
          kubernetesImagePullSecretName: kubernetesImagePullSecretName
          kubernetesPullSecretContent: kubernetesPullSecretContent
          certManagerIssuer: certManagerIssuer
          isKubernetesOperatorControlled: true
          kubernetesOperatorControlled: true
          kubeConfig: kubeConfig
          kubeDomain: kubeDomain
          overrides: overrides
          certManagerIssuerName: certManagerIssuerName
          kubernetesPullSecret: kubernetesPullSecret
          kubeConfigName: kubeConfigName
          certManagerIssuerKind: certManagerIssuerKind
          kubePodAddressTemplate: kubePodAddressTemplate
          kubernetesProvider: kubernetesProvider
          kubeConfigContent: kubeConfigContent
          kubernetesPullSecretName: kubernetesPullSecretName
          certManagerIssuerGroup: certManagerIssuerGroup
          kubernetesImageRegistry: kubernetesImageRegistry
          certManagerClusterIssuer: certManagerClusterIssuer
          kubernetesStorageClass: kubernetesStorageClass
          kubernetesServiceAccount: kubernetesServiceAccount
      properties:
        kubernetes:
          $ref: '#/components/schemas/KubernetesRegionInfo'
      type: object
    CloudSpecificInfo:
      description: Node information reported by the cloud provider
      example:
        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
      properties:
        assignPublicIP:
          description: True if the node has a public IP address assigned
          type: boolean
        az:
          description: The node's availability zone
          type: string
        cloud:
          description: The node's cloud provider
          type: string
        instance_type:
          description: The node's instance type
          type: string
        kubernetesNamespace:
          description: Kubernetes namespace
          type: string
        kubernetesPodName:
         

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