Back to Yugabyte Db

YugabyteDB Anywhere REST API

docs/content/v2025.1/yugabyte-platform/anywhere-automation/anywhere-api.md

2026.1.0.0-b29909 B
Original Source

The YugabyteDB Anywhere REST API allows you to deploy and manage universes programmatically. Some examples of what you can accomplish using this API include:

  • Create and manage YugabyteDB Anywhere provider configurations
  • Deploy and manage universes
  • Pause and resume universes
  • Perform software upgrades
  • Run on-demand backups and restores
  • Resize nodes

If you use Python, check out the Jupyter notebooks in the yugabyte-db GitHub repository for examples of performing various tasks using the API.

{{< sections/2-boxes >}} {{< sections/bottom-image-box title="Get Started" description="Manage YugabyteDB Anywhere using the API." buttonText="API Documentation" buttonUrl="https://api-docs.yugabyte.com/docs/yugabyte-platform/f10502c9c9623-yugabyte-db-anywhere-api-overview"

}}

{{< /sections/2-boxes >}}