yba-api
Installation
SKILL.md
YugabyteDB Anywhere REST API
This skill covers the YBA control-plane REST API — the HTTP API exposed by a self-managed YugabyteDB Anywhere (YBA) instance for managing providers, releases, universes, backups, KMS, alerts, HA, RBAC, and DR.
It is not about:
- YugabyteDB Aeon — fully-managed cloud DBaaS, different API surface.
- YSQL / YCQL — the database APIs (PostgreSQL- and Cassandra-compatible) on ports 5433 / 9042.
Reference docs:
- Overview: https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- Interactive reference: https://api-docs.yugabyte.com/docs/yugabyte-platform/f10502c9c9623-yugabyte-db-anywhere-api-overview
- v1 endpoint registry (Play routes): https://github.com/yugabyte/yugabyte-db/blob/master/managed/src/main/resources/v1.routes
- v2 OpenAPI spec: https://github.com/yugabyte/yugabyte-db/tree/master/managed/src/main/resources/openapi (entry point:
paths/_index.yaml)
This skill includes:
references/python-client.md— minimal Python wrapper (yba_request) plus splat-style usage. Read this when writing or generating Python code.references/powershell-client.md— standalone PowerShell wrapper (Invoke-YbaRequest,Get-YbaApiToken,Register-YbaInstance,Get-YbaCustomerId) that does not require thepowershell-ybamodule. Read this when the user is on PowerShell or has no Python available.references/recipes.md— concrete request/response shapes for register/login, providers, releases, v1 and v2 universe creation (cloud and Kubernetes), storage configs (incl. multi-region S3 with HTTPS proxy), telemetry providers, universe health checks and alerts, runtime configuration at all scopes, backups/restore, and async tasks. Read this when crafting an unfamiliar request.references/prometheus.md— querying the Prometheus instance bundled with YBA on port 9090 for universe metrics (YCQL/YSQL ops/sec, latency histograms, container CPU/memory on Kubernetes, node-exporter CPU on cloud, tablet-leader balance, xCluster lag). Includes Python and PowerShell helpers and thenode_prefix/ pod-regex derivation from a universe API response. Read this when the user wants metrics, dashboards or charts.