Manage API Keys in Confluent Cloud

API keys are used to authenticate and authorize access to Confluent Cloud resources. You can view, add, edit, and delete API keys using the Confluent Cloud Console, Confluent CLI, or the Confluent Cloud API. The following sections provide details on how to manage API keys using the Confluent Cloud Console and Confluent CLI. For information on using the Confluent Cloud API, see API Keys (iam/v2) - Confluent Cloud APIs.

Add an API key

You can create an API key for Confluent Cloud components and resources using the Confluent Cloud Console or the Confluent CLI.

Important

API keys propagate quickly after creation, usually within a few minutes. If you try to use an API key before propagation completes, authentication failures occur. Depending on workloads, you might need to wait a few minutes more and try again.

  1. Go to the API keys page at https://confluent.cloud/settings/api-keys.

    You can also navigate to the API keys page by expanding the sidebar menu in the Confluent Cloud Console and selecting API keys.

    The API keys page displays a list of all the API keys that you have.

  2. Click Add API key.

    The Create API key page displays.

  3. Select an account for the API key.

    My account

    Creates an API key credential for the current user account. Recommended for development and testing.

    Anyone with this credential can access the resources associated with this account.

    Service account

    Creates an API key credential for a service account. Recommended for production use.

    Service account name: For Existing account, select the service account, or for a new service account, enter a meaningful name and a description.

  4. Click Next.

    The Resource scope page displays.

  5. Select one of the following resource scopes for the API key and provide the required information:

    Resource scope Description Required action
    Kafka cluster Use to access the specified Kafka cluster. Select the Environment and Cluster.
    Schema Registry Use to access the specified Schema Registry. Select the Environment and Schema Registry.
    ksqlDB cluster Use to access the specified ksqlDB application. Select the Environment and ksqlDB cluster.
    Flink region Use to access to the Flink compute pools and statements in the specified Flink region. Select the Environment, Cloud provider, and Region.
    Cloud resource management Use to access resource management APIs for Confluent Cloud resources in your organization. No additional action required.
  6. Click Next.

    The API key detail page displays.

  7. Optionally, you can add a meaningful name and description for the API key.

  8. Click Create API key.

    The API key download page displays the new API key and secret. You can click Download API key to save the API key and secret and store in a secure location. After you click Complete, the API secret is no longer available.

  9. Click Complete.

    The API keys page displays, including the new API key.

View API keys

API keys are used to authenticate and authorize access to Confluent Cloud resources. You can view your existing API keys that you have created in the Confluent Cloud Console or using the Confluent CLI.

Go to the API keys page at https://confluent.cloud/settings/api-keys.

You can also navigate to the API keys page by expanding the sidebar menu and selecting API keys.

The API keys page displays a list of all the API keys that you have.

Edit an API key

  1. Go to the API keys page at https://confluent.cloud/settings/api-keys.

    You can also navigate to the API keys page by expanding the sidebar menu and selecting API keys.

    The API keys page displays a list of all the API keys that you have.

  2. Click the API key that you want to edit.

    The API key details page displays.

  3. Make your changes in the Name and Description fields.

    After making changes, the Save is enabled.

  4. Click Save.

    The API key is updated.

Delete an API key

You should delete API key if it no longer needed or if its secret is compromised. Follow the steps below to delete an API key using the Confluent Cloud Console or Confluent CLI.

  1. Go to the API keys page at https://confluent.cloud/settings/api-keys.

    You can also navigate to the API keys page by expanding the sidebar menu and selecting API keys.

    The API keys page displays a list of all the API keys that you have.

  2. Click the API key that you want to delete.

    The API key details page displays.

  3. Click Delete API key.

    The Confirm API key deletion dialog displays.

  4. After reviewing the notification, enter “CONFIRM” to delete the API key, and then click Confirm.

    The API key is deleted and any applications using the API key will stop. This action cannot be undone.