YugabyteDB
YugabyteDB Universe management API

The Universe management API from YugabyteDB — 11 operation(s) for universe management.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Universe management API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: name
        schema:
          default: 'null'
          type: string
        example: 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/UniverseResp'
                type: array
              examples:
                ListUniverses200Example:
                  summary: Default listUniverses 200 response
                  x-microcks-default: true
                  value:
                  - allowedTasks:
                      restricted: true
                      taskIds:
                      - taskIds
                      - taskIds
                    drConfigUuidsAsTarget:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    universeConfig:
                      key: universeConfig
                    dnsName: dnsName
                    pricePerHour: 0.8008281904610115
                    resources:
                      numCores: 5.637376656633329
                      volumeSizeGB: 3
                      gp3FreeThroughput: 1
                      numNodes: 2
                      memSizeGB: 5.962133916683182
                      azList:
                      - azList
                      - azList
                      pricePerHour: 7.061401241503109
                      volumeCount: 9
                      pricingKnown: true
                      gp3FreePiops: 6
                      ebsPricePerHour: 0.8008281904610115
                    creationDate: creationDate
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    version: 3
                    drConfigUuidsAsSource:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    universeDetails:
                      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-0b8a-43b9-b35d-6489e6daee91
                        - 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-0b8a-43b9-b35d-6489e6daee91
                        clusterType: PRIMARY
                        placementInfo:
                          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
                        regions:
                        - securityGroupId: securityGroupId
                          code: us-west-2
                          ybImage: TODO
                          latitude: 37.22
                          name: US West (Oregon)
                          active: true
                          details:
                            cloudInfo:
                              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
                                certManager

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

Documentation

Specifications

Other Resources

OpenAPI Specification
