Update a service account

PATCH/admin/service-accounts/{service_account_id}Update a service account

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

Parameters

X-Pinecone-Api-Versionstringheaderrequired

Required date-based version header

default "2026-07"

service_account_idstring · uuidpathrequired

The unique identifier of the service account.

Request body

required

Updated metadata for the service account.

application/json

objectUpdateServiceAccountRequest

namestring

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

maxLength 80 · minLength 1

Example request

{
  "name": "ci-prod-renamed"
}

Responses

objectServiceAccount

A service account. The OAuth `client_secret` is not included.

client_idstringrequired

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

created_atstring · date-timerequired

The date and time the service account was created.

idstring · uuidrequired

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.

namestringrequired

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

maxLength 80 · minLength 1

updated_atstring · date-timerequired

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

Example response

{
  "client_id": "l3Ow0CmFyc4jOONcwiKUCRqQKN0tiCAn",
  "created_at": "2026-04-10T15:23:00Z",
  "id": "f8a3b2c1-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "name": "My Service Account",
  "updated_at": "2026-04-12T09:11:00Z"
}

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

service_account_idrequiredpath parameter

curl -X PATCH 'https://api.pinecone.io/admin/service-accounts/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"name":"ci-prod-renamed"}'

const response = await fetch('https://api.pinecone.io/admin/service-accounts/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"ci-prod-renamed"}),
});
const data = await response.json();

const response = await fetch('https://api.pinecone.io/admin/service-accounts/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"name\":\"ci-prod-renamed\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.pinecone.io/admin/service-accounts/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"name":"ci-prod-renamed"}',
)
print(response.json())

package main

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

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

require 'net/http'

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

{
  "client_id": "l3Ow0CmFyc4jOONcwiKUCRqQKN0tiCAn",
  "created_at": "2026-04-10T15:23:00Z",
  "id": "f8a3b2c1-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "name": "My Service Account",
  "updated_at": "2026-04-12T09:11:00Z"
}

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

Update a service account

Parameters

Request body

Responses

API Keys

Organizations

Projects

Users

Invites

Service Accounts

Role Bindings