yba-api

Automate YugabyteDB Anywhere REST API operations across v1 and v2 endpoints.

6|4|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/yugabyte/yugabytedb-skills --skill yba-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: yba-api
Source: https://github.com/yugabyte/yugabytedb-skills/tree/main/skills/yba-api
Command: npx skills add https://github.com/yugabyte/yugabytedb-skills --skill yba-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams automate and troubleshoot YugabyteDB Anywhere REST API workflows — the control plane for managing providers, releases, universes, backups, KMS, alerts, and runtime configuration.

Core Features & Use Cases

  • Centralized automation of YBA v1 and v2 endpoints across cloud and Kubernetes deployments.
  • Provided Python and PowerShell wrappers, plus reference recipes to drive common tasks like universes, providers, backups, and telemetry.
  • Rich guidance via the included references to accelerate integration, testing, and operational playbooks.

Quick Start

Use this skill to automate a YBA workflow end-to-end.

Frequently Asked Questions about yba-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate YugabyteDB Anywhere REST API operations for universe management?

Automate YugabyteDB Anywhere REST API operations using minimal Python or PowerShell wrappers to manage providers, releases, universes, backups, KMS, alerts, and runtime configurations. The skill provides reference recipes and guidance for both v1 and v2 endpoints.

Can I use PowerShell to interact with YugabyteDB Anywhere backups and providers?

Yes, PowerShell wrappers can interact with YugabyteDB Anywhere backups and providers. The skill provides concrete workflow recipes supporting both Python and PowerShell to drive common automation tasks across cloud and Kubernetes deployments.

What authentication is required for YugabyteDB Anywhere API automation?

YugabyteDB Anywhere API automation requires API token authentication to construct robust workflows. It also supports asynchronous task polling to handle long-running operations like universe creation and backup execution properly.

Does the YugabyteDB Anywhere API support both v1 and v2 endpoints?

Yes, the YugabyteDB Anywhere API supports both v1 and v2 endpoints. The skill centralizes automation across these endpoints to manage universes, KMS, telemetry, and runtime configurations in cloud and Kubernetes deployments.

What's the best way to handle asynchronous tasks when automating YBA workflows?

The best way to handle asynchronous YBA tasks is leveraging the skill's built-in polling support and runtime configuration guidance. This ensures your Python or PowerShell automation correctly tracks long-running operations like backups and universe provisioning.

Why do my YugabyteDB Anywhere API calls fail during universe provisioning?

YugabyteDB Anywhere API calls fail during universe provisioning if API token authentication is missing or asynchronous task polling is not implemented. The skill includes references and scripts to construct robust automation that avoids these common workflow errors.