Update a project

PATCH/admin/projects/{project_id}Update a project

Update a project's name, maximum number of Pods, or customer-managed encryption key (CMEK).

Parameters

X-Pinecone-Api-Versionstringheaderrequired

Required date-based version header

default "2026-07"

project_idstring · uuidpathrequired

Project ID

Request body

required

Project details to be updated. Fields that are omitted will not be updated.

application/json

objectUpdateProjectRequest

force_encryption_with_cmekboolean

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

max_podsinteger

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

namestring

The name of the new project.

maxLength 512 · minLength 1

Example request

{
  "force_encryption_with_cmek": true,
  "max_pods": 0,
  "name": "chatbot-prod"
}

Responses

objectProject

The details of a project.

created_atstring · date-time

The date and time when the project was created.

force_encryption_with_cmekbooleanrequired

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

idstring · uuidrequired

The unique ID of the project.

max_podsintegerrequired

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

namestringrequired

The name of the project.

maxLength 512 · minLength 1

organization_idstringrequired

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

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "force_encryption_with_cmek": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "max_pods": 0,
  "name": "string",
  "organization_id": "string"
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

The error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

Examples

X-Pinecone-Api-Versionrequiredheader parameter

project_idrequiredpath parameter

curl -X PATCH 'https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"force_encryption_with_cmek":true,"max_pods":0,"name":"chatbot-prod"}'

const response = await fetch('https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"force_encryption_with_cmek":true,"max_pods":0,"name":"chatbot-prod"}),
});
const data = await response.json();

const response = await fetch('https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"force_encryption_with_cmek\":true,\"max_pods\":0,\"name\":\"chatbot-prod\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"force_encryption_with_cmek":true,"max_pods":0,"name":"chatbot-prod"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"force_encryption_with_cmek":true,"max_pods":0,"name":"chatbot-prod"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"force_encryption_with_cmek\":true,\"max_pods\":0,\"name\":\"chatbot-prod\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"force_encryption_with_cmek\":true,\"max_pods\":0,\"name\":\"chatbot-prod\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"force_encryption_with_cmek\":true,\"max_pods\":0,\"name\":\"chatbot-prod\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"force_encryption_with_cmek\":true,\"max_pods\":0,\"name\":\"chatbot-prod\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "created_at": "2026-06-09T00:00:00Z",
  "force_encryption_with_cmek": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "max_pods": 0,
  "name": "string",
  "organization_id": "string"
}

{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

Search documentation

API Keys

Organizations

Projects

Users

Invites

Service Accounts

Role Bindings

Parameters

Request body

Responses

API Keys

Organizations

Projects

Users

Invites

Service Accounts

Role Bindings