Turn your existing data & APIs into governed capabilities for AI →

API Learnings

Toolbox

API Evangelist LLC

yugabytedb

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 GitHub OpenAPI

Documentation

https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

https://api-docs.yugabyte.com/docs/yugabyte-platform/

https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Specifications

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-universes.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-backups-restore.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-providers-infra.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-alerts-monitoring.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-users-rbac.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-releases-maintenance.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-high-availability.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v2-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-anywhere-v1-full.yaml

SDKs

https://github.com/yugabyte/platform-go-client

Other Resources

https://github.com/yugabyte/terraform-provider-yba

https://github.com/yugabyte/yugabyte-k8s-operator

crd/yugabytedb-ybuniverse.yaml

crd/yugabytedb-backup.yaml

crd/yugabytedb-backup-schedule.yaml

crd/yugabytedb-restore-job.yaml

crd/yugabytedb-storage-config.yaml

crd/yugabytedb-dr-config.yaml

crd/yugabytedb-pitr-config.yaml

crd/yugabytedb-release.yaml

crd/yugabytedb-support-bundle.yaml

crd/yugabytedb-ybcertificate.yaml

crd/yugabytedb-ybprovider.yaml

crd/yugabytedb-ybplatform.yaml

https://www.yugabyte.com/yugabytedb-managed-service-terms/

OpenAPI

#Anywhere #Backups #Distributed SQL #Self-Managed #Universes

← Back to Y APIs