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](/assets/images/wcs-api-keys-cd74c488bd89ade94f247865e5d11c14.jpg)
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:
- Click the
Details
button. - Click the
API keys
button. - Click
Add Key
.
![Add API key UI](/assets/images/wcs-add-key-details-c97113914ef35add0ac8faceb4e9c3e3.jpg)
- Choose the key scope, read-only or admin.
- 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:
- Click the
Details
button. - Click the
API keys
button. - Click the trash-can icon to delete the API key.
![Delete API key UI](/assets/images/wcs-delete-api-key-985f004385d4017577327c37de823015.jpg)
Retrieve your API keys
To retrieve your API keys, follow these steps:
- Open the WCD console and find the details panel for your cluster.
![API key button](/assets/images/wcs-api-keys-panel-26e774166a8b53d61263a9da6d78eddd.jpg)
- Click the
API keys
button. - Copy the key and store it in a safe location.
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.