Y

yugabyte.com

Yugabyte provides distributed SQL database products including the open source YugabyteDB engine, the self-managed YugabyteDB Anywhere control plane, and the fully managed YugabyteDB Aeon service. These products are used to run and manage YugabyteDB database clusters across local, cloud, and hybrid environments.

5 integrations · REST · CLI

Yugabyte exposes two documented management REST APIs (YugabyteDB Aeon and YugabyteDB Anywhere) plus three CLIs: `ybm`, `yba`, and the local `yugabyted` utility; the documented management surfaces use an Aeon API key or an Anywhere API token.

discovered 2mo ago
REST · OpenAPI2
CLI3
Credentials
YugabyteDB Aeon API keybearerGet token ↗

In the YugabyteDB Aeon UI, create an API key from the _API Keys_ page. The Aeon API auth docs say any user with the Admin role can create API keys, and the CLI docs say you can then store it with ybm auth or provide it via the YBM_APIKEY environment variable. See Authentication and YugabyteDB Aeon CLI.

YugabyteDB Anywhere API tokenapi_keyGet key ↗

In YugabyteDB Anywhere, open the user menu and go to Profile → General, then copy the API token. If the field is blank, click Generate Key; generating a new token invalidates the previous one. The same token can be supplied to the CLI with the YBA_APITOKEN environment variable. See YugabyteDB Anywhere API overview and YugabyteDB Anywhere CLI.

conventions · 1/8 published

Publish these signals → /publishing