PATCH /admin/api-keys/{api_key_id}
Update the name and roles of an API key.
Servers
- https://api.pinecone.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_key_id |
String | Yes |
API key ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Pinecone-Api-Version |
String | Yes |
Required date-based version header Default value: "2025-10" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
A new name for the API key. The name must be 1-80 characters long. If omitted, the name will not be updated. |
roles[] |
Array | No |
A new set of roles for the API key. Existing roles will be removed if not included. If this field is omitted, the roles will not be updated. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.