# YugabyteDB Universe API **Canonical:** https://apis.io/apis/yugabyte/yugabytedb-universe-api/ **Provider:** Yugabyte — https://apis.io/providers/yugabyte/ **Base URL:** https://cloud.yugabyte.com/api/public/v1 **Documentation:** https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/ YugabyteDB Universe API is one of 82 APIs that [Yugabyte](https://apis.io/providers/yugabyte/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Universe. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs. CRUD operations for a Universe ## Operations (35) | Method | Path | Summary | |---|---|---| | 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 | ## Machine-readable artifacts (27) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-universe-api-openapi.yml - **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/ - **CLI** — https://github.com/yugabyte/ybm-cli - **Integrations** — https://github.com/yugabyte/terraform-provider-ybm - **TermsOfService** — https://www.yugabyte.com/yugabytedb-managed-service-terms/ - **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/ - **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 ## Other Yugabyte APIs (12) - [YugabyteDB Aeon REST API](https://apis.io/apis/yugabyte/yugabytedb-aeon-rest-api/) - [Yugabyte Backup Info API](https://apis.io/apis/yugabyte/yugabyte-backup-info-api/) - [Yugabyte Cluster API](https://apis.io/apis/yugabyte/yugabyte-cluster-api/) - [Yugabyte Cluster Info API](https://apis.io/apis/yugabyte/yugabyte-cluster-info-api/) - [Yugabyte Pitr Info API](https://apis.io/apis/yugabyte/yugabyte-pitr-info-api/) - [Yugabyte Restore Info API](https://apis.io/apis/yugabyte/yugabyte-restore-info-api/) - [Yugabyte Voyager Info API](https://apis.io/apis/yugabyte/yugabyte-voyager-info-api/) - [Yugabyte Voyager Metrics API](https://apis.io/apis/yugabyte/yugabyte-voyager-metrics-api/) - [Yugabyte Xcluster Metrics API](https://apis.io/apis/yugabyte/yugabyte-xcluster-metrics-api/) - [Yugabyte Xcluster Namespace Details API](https://apis.io/apis/yugabyte/yugabyte-xcluster-namespace-details-api/) - [YugabyteDB Access Keys API](https://apis.io/apis/yugabyte/yugabytedb-access-keys-api/) - [YugabyteDB Accounts API](https://apis.io/apis/yugabyte/yugabytedb-accounts-api/) ## Tags Universe --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yugabyte/yugabytedb-universe-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yugabyte/.