Skip to main content

Manage authentication

By default, API keys are enabled for all WCD clusters.

There are two types of API key, ReadOnly and Admin.

  • Admin keys are read-write.
  • ReadOnly keys do not grant write access to the database.

Serverless clusters have an administrator key and a read-only key. If you have a Serverless cluster, you can create and delete API keys.

Sandbox clusters have an administrator key. You cannot modify the Sandbox key.

Enable MFA icon

Create an API key​

If you have a Serverless cluster, you can create new API keys.

This action restarts the cluster. If you have a stand-alone cluster, there is a short downtime while the cluster restarts. There is no downtime if you have a high availability cluster.

To create a new API key, follow these steps:

  1. Click the Details button.
  2. Click the API keys button.
  3. Click Add Key.
Add API key UI
  1. Choose the key scope, read-only or admin.
  2. Click Generate to create the key.

Delete an API key​

If you have a Serverless cluster, you can delete API keys.

This action restarts the cluster. If you have a stand-alone cluster, there is a short downtime while the cluster restarts. There is no downtime if you have a high availability cluster.

To delete an API key, follow these steps:

  1. Click the Details button.
  2. Click the API keys button.
  3. Click the trash-can icon to delete the API key.
Delete API key UI

Retrieve your API keys​

To retrieve your API keys, follow these steps:

  1. Open the WCD console and find the details panel for your cluster.
API key button
  1. Click the API keys button.
  2. Copy the key and store it in a safe location.

Support​

For help with Serverless, Enterprise SaaS, and Bring Your Own Cloud accounts, contact Weaviate support directly to open a support ticket.

For questions and support from the Weaviate community, try these resources:

To add a support plan, contact Weaviate sales.