Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Update a service account

Update a service account's name; role bindings are managed through the role-binding endpoints.

PATCH/admin/service-accounts/{service_account_id}

Update a service account

2 parameters
  • X-Pinecone-Api-Versionstringheaderrequired

    Required date-based version header

  • service_account_idstringpathrequired

    The unique identifier of the service account.

cURL
curl --request PATCH \
  --url https://api.pinecone.io/admin/service-accounts/{service_account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Pinecone-Api-Version: <x-pinecone-api-version>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "ci-prod-renamed"
}'
Python
import requests

url = "https://api.pinecone.io/admin/service-accounts/{service_account_id}"

payload = {
  "name": "ci-prod-renamed"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Pinecone-Api-Version": "<x-pinecone-api-version>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
JavaScript
const options = {method: "PATCH", headers: {"Authorization": "Bearer <token>", "X-Pinecone-Api-Version": "<x-pinecone-api-version>", "Content-Type": "application/json"}, body: JSON.stringify({
  "name": "ci-prod-renamed"
})};

fetch("https://api.pinecone.io/admin/service-accounts/{service_account_id}", options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pinecone.io/admin/service-accounts/{service_account_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"name\":\"ci-prod-renamed\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Pinecone-Api-Version: <x-pinecone-api-version>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinecone.io/admin/service-accounts/{service_account_id}"

	payload := strings.NewReader("{\"name\":\"ci-prod-renamed\"}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
Java
HttpResponse<String> response = Unirest.patch("https://api.pinecone.io/admin/service-accounts/{service_account_id}")
  .header("Authorization", "Bearer <token>")
  .header("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
  .header("Content-Type", "application/json")
  .body("{\"name\":\"ci-prod-renamed\"}")
  .asString();
Ruby
require 'uri'
require 'net/http'

url = URI("https://api.pinecone.io/admin/service-accounts/{service_account_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Pinecone-Api-Version"] = '<x-pinecone-api-version>'
request["Content-Type"] = 'application/json'
request.body = "{\"name\":\"ci-prod-renamed\"}"

response = http.request(request)
puts response.read_body
200
{
  "client_id": "l3Ow0CmFyc4jOONcwiKUCRqQKN0tiCAn",
  "created_at": "2026-04-10T15:23:00.000Z",
  "id": "f8a3b2c1-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "name": "My Service Account",
  "updated_at": "2026-04-12T09:11:00.000Z"
}
400
{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}
401
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}
403
{
  "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
}
404
{
  "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
}
500
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
4XX
{
  "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
}
Authorizationstringrequired

An access token must be provided in the Authorization header using the Bearer scheme.

X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-07
service_account_idstringrequired

The unique identifier of the service account.

Typestring

Updated metadata for the service account.

name?string

A new name for the service account. If omitted, the name is unchanged.

Required string length: 1 - 80. Example: ci-prod-renamed

Typestring

200 — Service account updated successfully.

A service account. The OAuth client_secret is not included.

idstringrequired

The unique identifier for the service account. Use this as the path parameter on /admin/service-accounts/service_account_id endpoints and as the principal_id when querying or creating role bindings.

Typestring
namestringrequired

A short human-readable label, set by the caller at creation time.

Required string length: 1 - 80

Typestring
client_idstringrequired

The OAuth client ID used by the service account to obtain access tokens. Used only for OAuth token exchange.

Typestring
created_atstringrequired

The date and time the service account was created.

Typestring
updated_atstringrequired

The date and time of the service account's most recent metadata update.

Typestring
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu