Get API key details
Get an API key's details, excluding its secret.
// Requires Node.js SDK v8.2.0 or later
import { AdminClient } from '@pinecone-database/pinecone';
// Reads PINECONE_CLIENT_ID and PINECONE_CLIENT_SECRET from the environment
const admin = new AdminClient();
const apiKey = await admin.apiKeys.describe('YOUR_API_KEY_ID');
console.log(apiKey);// Requires Go SDK v6.0.0 or later
package main
import (
"context"
"fmt"
"log"
"os"
"github.com/pinecone-io/go-pinecone/v6/pinecone"
)
func main() {
ctx := context.Background()
adminClient, err := pinecone.NewAdminClientWithContext(ctx, pinecone.NewAdminClientParams{
ClientId: os.Getenv("PINECONE_CLIENT_ID"),
ClientSecret: os.Getenv("PINECONE_CLIENT_SECRET"),
})
if err != nil {
log.Fatalf("Failed to create AdminClient: %v", err)
}
apiKey, err := adminClient.APIKey.Describe(ctx, "YOUR_API_KEY_ID")
if err != nil {
log.Fatalf("Failed to describe API key: %v", err)
}
fmt.Printf("API key: %v (%v)\n", apiKey.Name, apiKey.Id)
}PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
PINECONE_API_KEY_ID="3fa85f64-5717-4562-b3fc-2c963f66afa6"
curl -X GET "https://api.pinecone.io/admin/api-keys/$PINECONE_API_KEY_ID" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-H "accept: application/json" \
-H "X-Pinecone-Api-Version: 2026-04"{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"roles": [
"ProjectEditor"
]
}GET
/admin/api-keys/{api_key_id}Get API key details
2 parameters
- X-Pinecone-Api-Versionstringheaderrequired
Required date-based version header
- api_key_idstringpathrequired
API key ID
Authorizations
Section titled “Authorizations”AuthorizationstringrequiredAn access token must be provided in the Authorization header using the Bearer scheme.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Path Parameters
Section titled “Path Parameters”api_key_idstringrequiredAPI key ID
Response
Section titled “Response”200 — The details of the API key, excluding the API key secret.
The details of an API key, without the secret.
idstringrequiredThe unique ID of the API key.
namestringrequiredThe name of the API key.
project_idstringrequiredThe ID of the project containing the API key.
rolesstring[]requiredThe roles assigned to the API key.