YugabyteDB
YugabyteDB Universe API

CRUD operations for a Universe
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Universe 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:
- description: CRUD operations for a Universe
  name: Universe
paths:
  /customers/{cUUID}/universes/{uniUUID}:
    delete:
      description: Delete Universe.
      operationId: deleteUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      requestBody:
        $ref: '#/components/requestBodies/UniverseDeleteReq'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBATask'
              examples:
                DeleteUniverse202Example:
                  summary: Default deleteUniverse 202 response
                  x-microcks-default: true
                  value:
                    resource_uuid: f33e3c9b-75ab-4c30-80ad-cba85646ea39
                    task_uuid: 89a46d52-4edd-4736-922a-35177a0b990c
          description: task accepted
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete a Universe
      tags:
      - Universe
      x-yba-api-audit:
        auditTargetType: Universe
        auditTargetId: uniUUID.toString()
        auditActionType: Delete
        taskUuid: obj.getTaskUuid()
      x-yba-api-authz:
      - requiredPermission:
          resourceType: universe
          action: DELETE
        resourceLocation:
          path: UNIVERSES
          sourceType: ENDPOINT
        checkOnlyPermission: false
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Get details of a single YugabyteDB Universe.
      operationId: getUniverse
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Universe UUID
        explode: false
        in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Universe'
              examples:
                GetUniverse200Example:
                  summary: Default getUniverse 200 response
                  x-microcks-default: true
                  value:
                    spec:
                      yb_software_version: 2024.2.0.0-b600
                      networking_spec:
                        enable_ipv6: false
                        communication_ports:
                          internal_ysql_server_rpc_port: 6433
                          ysql_server_http_port: 13000
                          yql_server_http_port: 12000
                          tserver_http_port: 9000
                          yb_controller_http_port: 14000
                          redis_server_http_port: 11000
                          redis_server_rpc_port: 6379
                          ysql_server_rpc_port: 5433
                          master_rpc_port: 7100
                          tserver_rpc_port: 9100
                          yql_server_rpc_port: 9042
                          node_exporter_port: 9300
                          master_http_port: 7000
                          otel_collector_metrics_port: 8889
                          yb_controller_rpc_port: 18018
                        assign_public_ip: true
                        assign_static_public_ip: false
                      override_prebuilt_ami_db_version: true
                      name: my-yb-universe
                      encryption_in_transit_spec:
                        client_root_ca: 1711b83b-af74-416b-84b9-e9f66b532c82
                        enable_node_to_node_encrypt: false
                        enable_client_to_node_encrypt: false
                        root_ca: fce99806-03f0-4b17-9483-297ccfaa368d
                      use_time_sync: false
                      ysql:
                        password: password
                        enable_connection_pooling: true
                        enable: true
                        enable_auth: false
                      ycql:
                        password: password
                        enable: true
                        enable_auth: false
                      remote_package_path: remote_package_path
                      encryption_at_rest_spec:
                        kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                      clusters:
                      - replication_factor: 3
                        placement_spec:
                          cloud_list:
                          - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            region_list:
                            - code: code
                              name: name
                              lb_fqdn: lb_fqdn
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              az_list:
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                            - code: code
                              name: name
                              lb_fqdn: lb_fqdn
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              az_list:
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                            code: code
                            masters_in_default_region: true
                            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            region_list:
                            - code: code
                              name: name
                              lb_fqdn: lb_fqdn
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              az_list:
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                            - code: code
                              name: name
                              lb_fqdn: lb_fqdn
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              az_list:
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                              - subnet: subnet
                                num_nodes_in_az: 2
                                replication_factor: 5
                                leader_preference: 7
                                secondary_subnet: secondary_subnet
                                name: name
                                leader_affinity: true
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                lb_name: lb_name
                            code: code
                            masters_in_default_region: true
                            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        cluster_type: PRIMARY
                        uuid: 19ebde21-d537-47dc-8fab-3edc243c6f68
                        num_nodes: 3
                        provider_spec:
                          region_list:
                          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          provider: 89a46d52-4edd-4736-922a-35177a0b990c
                          access_key_code: aws-ssh-key
                          preferred_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          az_helm_overrides:
                            key: az_helm_overrides
                          aws_instance_profile: arn:aws:iam::myorg:instance-profile/testco-ec2-role
                          helm_overrides: "tserver:\n  resources:\n    requests:\n      cpu: 1\n      memory: 1Gi\n    limits:\n      cpu: 2\n      memory: 2Gi\n"
                          image_bundle_uuid: 914aa5a8-febc-44ba-9b60-ea3e22127218
                        partitions_spec:
                        - replication_factor: 9
                          default_partition: false
                          name: name
                          tablespace_name: tablespace_name
                          placement:
                            cloud_list:
                            - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              region_list:
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              code: code
                              masters_in_default_region: true
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              region_list:
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              code: code
                              masters_in_default_region: true
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          uuid: 19ebde21-d537-47dc-8fab-3edc243c6f68
                        - replication_factor: 9
                          default_partition: false
                          name: name
                          tablespace_name: tablespace_name
                          placement:
                            cloud_list:
                            - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              region_list:
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              code: code
                              masters_in_default_region: true
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            - default_region: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                              region_list:
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              - code: code
                                name: name
                                lb_fqdn: lb_fqdn
                                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                az_list:
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                                - subnet: subnet
                                  num_nodes_in_az: 2
                                  replication_factor: 5
                                  leader_preference: 7
                                  secondary_subnet: secondary_subnet
                                  name: name
                                  leader_affinity: true
                                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                                  lb_name: lb_name
                              code: code
                              masters_in_default_region: true
                              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                          uuid: 19ebde21-d537-47dc-8fab-3edc243c6f68
                        use_spot_instance: false
                        gflags:
                          tserver:
                            key: tserver
                          az_gflags:
                            key:
                              tserver:
                                key: tserver
                              master:
                                key: master
                          gflag_groups:
                          - ENHANCED_POSTGRES_COMPATIBILITY
                          master:
                            key: master
                        networking_spec:
                          az_networking:
                            key:
                              tserver: '{}'
                              proxy_config:
                                http_proxy: http://10.9.131.7:3128
                                https_proxy: http://10.9.131.7:3128
                                no_proxy_list:
                                - 10.150.0.26
                                - .amazonaws.com
                              master: '{}'
                          tserver: '{}'
                          proxy_config:
                            http_proxy: http://10.9.131.7:3128
                            https_proxy: http://10.9.131.7:3128
                            no_proxy_list:
                            - 10.150.0.26
                            - .amazonaws.com
                          enable_lb: false
                          enable_exposing_service: NONE
                          master: '{}'
                        metrics_export_config:
                          collection_level: NORMAL
                          scrape_interval_seconds: 30
                          scrape_timeout_seconds: 20
                          universe_metrics_exporter_config:
                          - additional_tags:
                              key: additional_tags
                            exporter_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            metrics_prefix: ybdb.
                            memory_limit_mib: 2048
                            send_batch_size: 100
                            memory_limit_check_interval_seconds: 10
                            send_batch_max_size: 1000
                            send_batch_timeout_seconds: 10
                          - additional_tags:
                              key: additional_tags
                            exporter_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                            metrics_prefix: ybdb.
                            memory_limit_mib: 2048
                            send_batch_size: 100
                            memory_limit_check_interval_seconds: 10
                            send_batch_max_size: 1000
                            send_batch_timeout_seconds: 10
                          scrape_config_targets:
                          - MASTER_EXPORT
                          - TSERVER_EXPORT
                          - YSQL_EXPORT
                          - CQL_EXPORT
                          - NODE_EXPORT
                          - NODE_AGENT_EXPORT
                          - OTEL_EXPORT
                        node_spec:
                          storage_spec:
                            mount_points: mount_points
                            storage_type: IO1
                            storage_class: storage_class
                            volume_size: 0
                            num_volumes: 6
                            throughput: 5
                            cloud_volume_encryption:
                              kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                              enable_volume_encryption: false
                            disk_iops: 1
                          tserver:
                            storage_spec:
                              mount_points: mount_points
                              storage_type: IO1
                              storage_class: storage_class
                              volume_size: 0
                              num_volumes: 6
                              throughput: 5
                              cloud_volume_encryption:
                                kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                                enable_volume_encryption: false
                              disk_iops: 1
                            instance_type: c5.xlarge
                          az_node_spec:
                            key:
                              storage_spec:
                                mount_points: mount_points
                                storage_type: IO1
                                storage_class: storage_class
                                volume_size: 0
                                num_volumes: 6
                                throughput: 5
                                cloud_volume_encryption:
                                  kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                                  enable_volume_encryption: false
                                disk_iops: 1
                              tserver:
                                storage_spec:
                                  mount_points: mount_points
                                  storage_type: IO1
                                  storage_class: storage_class
                                  volume_size: 0
                                  num_volumes: 6
                                  throughput: 5
                                  cloud_volume_encryption:
                                    kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                                    enable_volume_encryption: false
                                  disk_iops: 1
                                instance_type: c5.xlarge
                              cgroup_size: 1024
                              instance_type: c5.xlarge
                              master:
                                storage_spec:
                                  mount_points: mount_points
                                  storage_type: IO1
                                  storage_class: storage_class
                                  volume_size: 0
                                  num_volumes: 6
                                  throughput: 5
                                  cloud_volume_encryption:
                                    kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
                                    enable_volume_encryption: false
                                  disk_iops: 1
                                instance_type: c5.xlarge
                          cgroup_size: 1024
                          k8s_master_resource_spec:
                            memory_gib: 4
                            cpu_core_count: 2
                          k8s_tserver_resource_spec:
                            memory_gib: 4
                            cpu_core_count: 2
                          dedicated_nodes: false
                          instance_type: c5.xlarge
                          master:
                            storage_spec:
                              mount_points: mount_points
                              storage_type: IO1
                              storage_class: storage_class
                              volume_size: 0
                              num_volumes: 6
                              throughput: 5
                              cloud_volume_encryption:
                                kms_config_uuid: 123e4567-e89b-12d3-a456-426614174000
   

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

Documentation

Specifications

Other Resources

OpenAPI Specification
