Update an API key

PATCH/admin/api-keys/{api_key_id}Update an API key

Update an API key's name and roles.

Parameters

X-Pinecone-Api-Versionstringheaderrequired

Required date-based version header

default "2026-07"

api_key_idstring · uuidpathrequired

API key ID

Request body

required

Updated name and roles for the API key.

application/json

objectUpdateAPIKeyRequest

namestring

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

maxLength 80 · minLength 1

rolesarray of string

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.

Show child attributes

Example request

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

Responses

objectAPIKey

The details of an API key, without the secret.

idstring · uuidrequired

The unique ID of the API key.

namestringrequired

The name of the API key.

project_idstring · uuidrequired

The ID of the project containing the API key.

rolesarray of stringrequired

The roles assigned to the API key.

Show child attributes

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "roles": [
    "ProjectEditor"
  ]
}

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": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

Examples

X-Pinecone-Api-Versionrequiredheader parameter

api_key_idrequiredpath parameter

curl -X PATCH 'https://api.pinecone.io/admin/api-keys/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"name":"devkey","roles":["ProjectEditor"]}'

const response = await fetch('https://api.pinecone.io/admin/api-keys/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"devkey","roles":["ProjectEditor"]}),
});
const data = await response.json();

const response = await fetch('https://api.pinecone.io/admin/api-keys/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"name\":\"devkey\",\"roles\":[\"ProjectEditor\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.pinecone.io/admin/api-keys/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"name":"devkey","roles":["ProjectEditor"]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"name":"devkey","roles":["ProjectEditor"]}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.pinecone.io/admin/api-keys/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/api-keys/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"name\":\"devkey\",\"roles\":[\"ProjectEditor\"]}");
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/api-keys/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"devkey\",\"roles\":[\"ProjectEditor\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.pinecone.io/admin/api-keys/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"name\":\"devkey\",\"roles\":[\"ProjectEditor\"]}"
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/api-keys/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"name\":\"devkey\",\"roles\":[\"ProjectEditor\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "roles": [
    "ProjectEditor"
  ]
}

{
  "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": "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