Skip to main content

Manage authentication

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

There are two types of API keys, ReadOnly and Admin:

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

If you have a Serverless cluster, you can create and delete API keys. You cannot modify the Sandbox cluster keys.

Retrieve your API keys​

When connecting to a Weaviate Cloud cluster, you need an API key and the REST endpoint URL for authentication. To retrieve your connection details, follow these steps:

  1. Open the Weaviate Cloud console and select your cluster.
  2. On the Cluster details page, find the Admin API key and REST Endpoint URL.
  3. Copy the needed key and URL and store them in a safe location.
Get the (REST) endpoint URL
Grab the REST Endpoint URL.
Get the admin API key
Grab the Admin API key.

REST Endpoint vs gRPC Endpoint

When using an official Weaviate client library, you need to authenticate using the REST Endpoint. The client will infer the gRPC endpoint automatically and use the more performant gRPC protocol when available.

Create an API key​

If you have a Serverless cluster, you can create new API keys. To create a new API key, follow these steps:

  1. Open the Weaviate Cloud console.
  2. Select your cluster and find the API Keys section.
  3. Click on the New Key button (1).
Add new API key to a cluster
Add new API key to a cluster.

  1. Choose if you want an Admin or ReadOnly key.
  2. Click on the Create button.
Choose a type for the new API key
Choose a type for the new API key.
info

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.

Delete an API key​

If you have a Serverless cluster, you can delete API keys. To delete an API key, follow these steps:

  1. Open the Weaviate Cloud console.
  2. Select your cluster and find the API Keys section.
  3. Click on the Delete button next to the key you want to delete (1).
Delete an API key in Weaviate Cloud
Delete an API key in Weaviate Cloud.

  1. Enter the necessary text to confirm the deletion.
  2. Click on the Confirm and delete button.
Confirm API key deletion
Confirm API key deletion.
info

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.

Support​

For help with Serverless Cloud, Enterprise Cloud, 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.