v2025.2 LTS Stable release with long-term support v2025.1 STS Stable release with standard-term support v2024.2 LTS Stable release with long-term support v2024.1 STS Stable release with standard-term support v2.20 LTS Stable release with long-term support Unsupported versions

Automation

Manage YugabyteDB Anywhere accounts and deployments using automation

Use the following automation tools to manage your YugabyteDB Anywhere installation and universes:

Automation Description
REST API Deploy and manage database universes using a REST API.
Terraform provider Provider for automating YugabyteDB Anywhere resources that are accessible via the API.
CLI Manage YugabyteDB Anywhere resources from the command line.
YugabyteDB Kubernetes Operator Automate the deployment and management of YugabyteDB clusters in Kubernetes environments.

Authentication

For access, automation tools require authentication in the form of an API token. An API token is associated with a particular user account, and gives all the permissions that the user has. For example, if the user is an admin, that user's API token lets you use all of the admin privileged operations.

Generating a new API token invalidates your existing token. Only the most-recently generated API token is valid.

To obtain your API token:

  1. In YugabyteDB Anywhere, click the profile icon at the top right and choose User Profile.

  2. Under API Key management, copy your API token. If the API Token field is blank, click Generate Key, and then copy the resulting API token.

To obtain your API token using the REST API, you can use the Auth token generated when you sign in. (By default, Auth tokens expire after 12 hours.)

Do the following:

  1. Sign in to YugabyteDB Anywhere:

    curl --location --request POST 'https://<yba-ip>/api/v1/login' \
  --header 'Content-Type: application/json' \
  --data-raw '{ "email":"myemail@example.com","password":"mypassword" }' \
  -k

    This returns an Auth token. For example:

    {"authToken":"3efcf456aa78d912bfc3bd4ef5dcc678","customerUUID":"1e2c345d-e678-9fb1-b234-fcb56a78c9e0","userUUID":"234ec5e6-b7bd-8e90-1234-5bfe678d90d1"}%

  2. Use the Auth token to generate an API token:

    curl --request PUT \
--url https://<yba-ip>/api/v1/customers/1e2c345d-e678-9fb1-b234-fcb56a78c9e0/api_token \
--header 'Accept: application/json' \
--header 'X-AUTH-TOKEN: 3efcf456aa78d912bfc3bd4ef5dcc678' \
-k

    {"apiToken":"27011623-05b6-47cc-81a8-bce47ba911a4","apiTokenVersion":6,"customerUUID":"1e2c345d-e678-9fb1-b234-fcb56a78c9e0","userUUID":"234ec5e6-b7bd-8e90-1234-5bfe678d90d1"}%

Account details

For some REST API commands, you may need one or more of the following account details.

Customer ID

To view your customer ID, in YugabyteDB Anywhere, click the Profile icon in the top right corner of the YugabyteDB Anywhere window, and choose User Profile.

To get your customer UUID using the API, use the following command:

curl \
  -H "X-AUTH-YW-API-TOKEN: myYBAnywhereApiToken" \
    [http|https]://<yba-ip>/api/v1/customers

This returns the UUID. For example:

["1e2c345d-e678-9fb1-b234-fcb56a78c9e0"]

Universe ID

Every universe has a unique ID. To obtain a universe ID in YugabyteDB Anywhere, click Universes in the left column, then click the name of the universe. The URL of the universe's Overview page ends with the universe's UUID. For example:

https://myPlatformServer/universes/d73833fc-0812-4a01-98f8-f4f24db76dbe