Yugabyte

YugabyteDB Universe API

CRUD operations for a Universe

GitHub OpenAPI

Operations 35

DELETE /customers/{cUUID}/universes/{uniUUID} Delete a universe #
GET /customers/{cUUID}/universes/{uniUUID} Get a YugabyteDB Universe #
PUT /customers/{cUUID}/universes/{uniUUID} Edit a YugabyteDB Universe #
POST /customers/{cUUID}/universes Create a YugabyteDB Universe #
POST /customers/{cUUID}/universes/page List universes #
POST /customers/{cUUID}/universes/{uniUUID}/clusters Add a cluster to a YugabyteDB Universe #
DELETE /customers/{cUUID}/universes/{uniUUID}/clusters/{clsUUID} Delete an additional cluster(s) of a YugabyteDB Universe #
POST /customers/{cUUID}/fetch-universe-resources Get resource utilisation of a YugabyteDB Universe #
POST /customers/{cUUID}/universes/{uniUUID}/gflags Edit GFlags #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/software Upgrade YugabyteDB version #
GET /customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize Get finalize information on the YugabyteDB upgrade #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/software/finalize Finalize the Upgrade YugabyteDB #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/third-party-software Upgrade third party software #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/software/rollback Rollback YugabyteDB version #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/software/resume-canary Resume canary software upgrade #
POST /customers/{cUUID}/universes/{uniUUID}/upgrade/software/precheck Precheck YugabyteDB version upgrade #
POST /customers/{cUUID}/universes/{uniUUID}/restart Restart a YugabyteDB Universe #
POST /customers/{cUUID}/universes/{uniUUID}/systemd Migrate to Systemd controlled services #
POST /customers/{cUUID}/universes/{uniUUID}/encryption/in-transit Enable or disable encryption in transit #
POST /customers/{cUUID}/universes/{uniUUID}/encryption/in-transit/rotate Rotate TLS Certs #
POST /customers/{cUUID}/universes/{uniUUID}/kubernetes-overrides Edit Kubernetes Helm Overrides #
DELETE /customers/{cUUID}/universes/{uniUUID}/detach Rollback detach universe #
POST /customers/{cUUID}/universes/{uniUUID}/detach Detach universe #
POST /customers/{cUUID}/universes/{uniUUID}/attach Attach universe #
DELETE /customers/{cUUID}/universes/{uniUUID}/attach-detach-metadata Delete attach/detach metadata #
POST /customers/{cUUID}/universes/{uniUUID}/query-log-config Configure Query Log for YugabyteDB Universe #
POST /customers/{cUUID}/universes/{uniUUID}/metrics-export-config Configure metrics export #
POST /customers/{cUUID}/universes/{uniUUID}/export-telemetry-configs Configure export telemetry configs (unified API) #
POST /customers/{cUUID}/universes/{uniUUID}/operator-import Import universe to operator #
POST /customers/{cUUID}/universes/{uniUUID}/operator-import/precheck Precheck universe import to operator #
POST /customers/{cUUID}/universes/{uniUUID}/run-script Run a script on database nodes #
POST /customers/{cUUID}/universes/{uniUUID}/file-collections Collect files from database nodes #
GET /customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID}/download Download collected files #
DELETE /customers/{cUUID}/universes/{uniUUID}/file-collections/{collectionUUID} Delete collected files from database nodes and/or YBA #
POST /customers/{cUUID}/universes/{uniUUID}/resize-nodes Resize nodes in YBDB Universe #

Documentation

📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/managed-apis/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/yugabyte-platform/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-universe-api-openapi.yml

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybplatform.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yugabytedb-universe-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yugabytedb-universe-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@yugabyte.com
    name: YugabyteDB Anywhere Support
    url: https://docs.yugabyte.com
  description: An improved set of APIs for managing YugabyteDB Anywhere
  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
  title: YugabyteDB Anywhere V2 Universe API
  version: v2
servers:
- description: API endpoint of YBA server
  url: '{protocol}://{host_port}/api/v2'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host_port:
      default: localhost:9000
tags:


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