Manage API keys
Each Pinecone project has one or more API keys. In order to make calls to the Pinecone API, you must provide a valid API key for the relevant Pinecone project.
To view the API keys for your project in the Pinecone console, go to the API keys tab. From there, you can create, change permissions for, and delete API keys.
The ability to set API key permissions is in public preview.
If you use custom API key permissions, ensure that you target your index by host when performing data operations such as upsert
and query
.
Create an API key
To create a new API key for your project in the Pinecone console:
-
Open the Pinecone console.
-
Select your project.
-
Go to API keys.
-
Click Create API key.
-
Enter an API key name.
-
Select the Permissions to grant to the API key. For a description of the permission roles, see API key permissions.
Users on the Starter plan can set the permissions to All only. To customize the permissions further, upgrade to the Standard or Enterprise plan.
-
Click Create key.
-
Copy and save the generated API key in a secure place for future use.
You will not be able to see the API key again after you close the dialog.
-
Click Close.
Change API key permissions
Users on the Starter plan cannot change API key permissions once they are set. Instead, create a new API key or upgrade to the Standard or Enterprise plan.
If you are a project owner, you can change API key permissions:
-
Open the Pinecone console.
-
Select your project.
-
Go to the API keys tab.
-
In the row of the API key you want to change, click the Actions (…) icon > Manage.
-
Change the permissions for the API key as needed.
For information about the different API key permissions, refer to Understanding security - API keys.
-
Click Update.
Delete an API key
If you are a project owner, you can delete your API key:
-
Open the Pinecone console.
-
Select your project.
-
Go to the API keys tab.
-
In the row of the API key you want to change, click the Actions (…) icon > Delete.
-
Enter the API key name.
-
Click Confirm deletion.
Deleting an API key is irreversible and will immediately disable any applications using the API key.
Was this page helpful?