Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
API Keys

Update an API key

Update an API key's name and roles.

patch/admin/api-keys/{api_key_id}

Path parameters

api_key_idstring uuid required

API key ID

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring

A new name for the API key. The name must be 1-80 characters long. If omitted, the name will not be updated.

rolesstring[]

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.

Example request

{
  "name": "devkey",
  "roles": [
    "ProjectEditor"
  ]
}

Response

API key updated successfully.

idstring uuid required

The unique ID of the API key.

namestring required

The name of the API key.

project_idstring uuid required

The ID of the project containing the API key.

rolesstring[] required

The roles assigned to the API key.

Example response

{
  "roles": [
    "ProjectEditor"
  ]
}