Projects

Update a project

Update a project's configuration details. You can update the project's name, maximum number of Pods, or enable encryption with a customer-managed encryption key (CMEK).

patch/admin/projects/{project_id}

Request

Base URL
https://api.pinecone.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/pinecone/apis/pinecone-api/docs/admin/projects/:project_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

project_idstring uuid required

Project ID

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring

The name of the new project.

max_podsinteger

The maximum number of Pods that can be created in the project.

force_encryption_with_cmekboolean

Whether to force encryption with a customer-managed encryption key (CMEK). Once enabled, CMEK encryption cannot be disabled.

Example request

{
  "name": "chatbot-prod"
}

Response

The project was successfully updated.

idstring uuid required

The unique ID of the project.

namestring required

The name of the project.

max_podsinteger required

The maximum number of Pods that can be created in the project.

force_encryption_with_cmekboolean required

Whether to force encryption with a customer-managed encryption key (CMEK).

organization_idstring required

The unique ID of the organization that the project belongs to.

created_atstring date-time

The date and time when the project was created.

Changes

No recorded changes to this operation across all 1 revision of this API.