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
You can create a new API key for your project, as follows:- 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.
View project API keys
You can view the API keys for your project as in the following example:An access token must be provided to complete this action through the Admin API. The Admin API is in public preview.
curl
You can view the API keys for your project in the Pinecone console, on the API keys tab.
View API key details
You can view the details of an API key, as shown in the following example:An access token must be provided to complete this action through the Admin API. The Admin API is in public preview.
curl
Update an API key
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.
- 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 ellipsis (…) menu > Manage.
- Change the name and/or 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 ellipsis (…) menu > 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.