Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Get Started with the Management API v3.0

  • Capella Operational
  • how-to
    +
    To get started with the Management API v3.0, you must create an API key. An API key authenticates and authorizes you to access the Management API v3.0.

    This page describes how to create and manage API keys for the Management API v3.0, formerly known as the Public API. API keys for the Management API v3.0 are not compatible with the Management API v4.0.

    Deprecation Notice

    The Management API v3.0 is deprecated and will be removed in future. Users of the Management API v3.0 must plan to migrate to the Management API v4.0. See Manage Deployments with the Management API v4.0.

    Understand Legacy Management API Keys

    To use the Bearer token mechanism with the Management API v3.0, it is first necessary to obtain a legacy Management API key — this is done within Couchbase Capella UI.

    These keys are specific to your account in Couchbase Capella and also control authorization for API operations. For example, if you create a legacy Management API key from a Couchbase Capella account that cannot create a cluster, and then use that API key with the Management API v3.0 to create a cluster, the API call is refused.

    You can create legacy Management API keys at the organization level. A legacy Management API key is made up of two parts: an access key and a secret key.

    Display Legacy Management API Keys

    To display legacy Management API keys within an organization:

    1. In the Capella UI, navigate to the organization.

    2. Go to Settings  API Keys.

    3. If necessary, click Version 3.

    Generate Legacy Management API Keys

    To generate a legacy Management API key within an organization:

    1. Display the list of legacy Management API keys within the organization.

    2. Click Generate Key.

    3. Click Version 3 (Deprecated).

    4. In the Key Name field, enter a name for the API key.

    5. When you are ready, click Generate Key.

      The Capella UI shows the new API access key and the new API secret key. The API secret key is hidden to prevent others reading it.

      You must copy or download the API secret key now. When you leave this page, you won’t be able to copy or download the API secret key again.

    6. To download the API key, click Download Key. The key is saved by your browser in a file called <name>-api-key-token.txt, where <name> is the name of the API key.

    7. To copy either the API access key or the API secret key to the clipboard, click the copy icon () next to the field.

    8. When you have copied or downloaded the API secret key, click Back to API Keys list.

    The API key is now listed with the Management API v3.0 Keys.

    Delete Legacy Management API Keys

    To delete a legacy Management API key:

    1. Display the list of legacy Management API keys within an organization.

    2. Next to the API key you want to delete, click the trash can icon ().

    3. When the confirmation dialog box appears, click in the provided text field and type delete.

    4. Click Delete.

    The API key is deleted.

    Next Steps