YugabyteDB Anywhere REST API

REST discovered

Details

URL: [http|https]://<your-yba-server>/api
Docs: https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Authentication

YugabyteDB Anywhere API token api_key discovered Get key ↗

X-AUTH-YW-API-TOKEN: <credential>

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.