Automation in YugabyteDB Managed

Automation

Manage YugabyteDB Managed accounts and clusters using automation

Use the following automation tools to manage your YugabyteDB Managed account and clusters:

Automation Description
REST API Deploy and manage database clusters using a REST API.
Terraform provider Provider for automating YugabyteDB Managed resources that are accessible via the API.
CLI Manage YugabyteDB Managed resources from the command line.

Authentication

For access, automation tools require authentication in the form of an API key.

Account details

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

  • Account ID.

    To view your account ID, click the Profile icon in the top right corner of the YugabyteDB Managed window. The account ID is also displayed in the API Key Details sheet.

  • Project ID.

    The project ID is a unique identifier of the YugabyteDB Managed project under which database clusters can be deployed. Currently, accounts have only one project. The project ID is also available via the Profile icon in the top right corner of the YugabyteDB Managed window. The project ID is also displayed in the API Key Details sheet.

  • Cluster ID.

    Every cluster has a unique ID. The cluster ID is available via the cluster Settings tab.

These identifiers can also be found in the URL when you access a cluster using the YugabyteDB Managed user interface.

Automation