API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

YugabyteDB Anywhere REST API

The YugabyteDB Anywhere REST API enables programmatic management of self-managed YugabyteDB deployments through the YugabyteDB Anywhere (YBA) control plane. It supports creating and managing cloud provider configurations, deploying and managing universes (database clusters), pausing and resuming universes, performing software upgrades, executing backups and restores, and resizing nodes. Authentication is performed via the X-AUTH-YW-API-TOKEN HTTP header.

Documentation

Specifications

OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-universes.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-backups-restore.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-providers-infra.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-alerts-monitoring.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-users-rbac.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-releases-maintenance.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-high-availability.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v2-openapi.yaml
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-full.yaml

SDKs

Other Resources

🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
crd/yugabytedb-release.yaml
🔗
KubernetesCRD
crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
crd/yugabytedb-ybplatform.yaml
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/

OpenAPI

yugabytedb-anywhere-v1-universes.yaml Raw ↑