Configure an index
Configure an existing index.
For serverless indexes, you can configure only index deletion protection. For pod-based indexes, you can configure the pod size, number of replicas, and index deletion protection.
It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then create a new pod-based index with a different pod type from the collection. For guidance and examples, see Configure an index.
from pinecone.grpc import PineconeGRPC as Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")
pc.configure_index(
name="docs-example",
pod_type="p1.x2",
replicas=4,
deletion_protection="enabled"
)import { Pinecone } from '@pinecone-database/pinecone'
const pinecone = new Pinecone({
apiKey: 'YOUR_API_KEY'
});
await pinecone.configureIndex('docs-example', { podType: 'p1.x2', replicas: 4, deletionProtection: 'enabled' });import io.pinecone.clients.Pinecone;
public class ConfigureIndexExample {
public static void main(String[] args) {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
pc.configureIndex("docs-example", "p1.x2", 4, DeletionProtection.ENABLED);
}
}package main
import (
"context"
"fmt"
"log"
"github.com/pinecone-io/go-pinecone/v2/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: "YOUR_API_KEY",
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.ConfigureIndex(ctx, "docs-example", pinecone.ConfigureIndexParams{PodType: "p1.x2", Replicas: 4, DeletionProtection: "enabled"})
if err != nil {
log.Fatalf("Failed to configure index \"%v\": %v", idx.Name, err)
} else {
fmt.Printf("Successfully configured index \"%v\"", idx.Name)
}
}using Pinecone;
var pinecone = new PineconeClient("YOUR_API_KEY");
var indexMetadata = await pinecone.ConfigureIndexAsync("docs-example", new ConfigureIndexRequest
{
Spec = new ConfigureIndexRequestSpec
{
Pod = new ConfigureIndexRequestSpecPod {
Replicas = 4,
PodType = "p1.x2",
}
},
DeletionProtection = DeletionProtection.Disabled,
});PINECONE_API_KEY="YOUR_API_KEY"
curl -s -X PATCH "https://api.pinecone.io/indexes/docs-example" \
-H "Content-Type: application/json" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2024-07" \
-d '{
"spec": {
"pod": {
"pod_type": "p1.x2",
"replicas": 4
}
},
"deletion_protection": "disabled"
}'{
"name": "docs-example",
"metric": "cosine",
"dimension": 1536,
"status": {
"ready": true,
"state": "Ready"
},
"host": "docs-example1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
"spec": {
"serverless": {
"region": "us-east-1",
"cloud": "aws"
}
}
}PATCH /indexes/{index_name}
Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Path Parameters
Section titled “Path Parameters”index_namestringrequiredThe name of the index to configure.
The desired pod size and replica configuration for the index.
spec?objectShow child attributes
podobjectrequiredShow child attributes
replicas?integerThe number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
Required range: 1 <= x
pod_type?stringThe type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
deletion_protection?enum<string>Available options: disabled, enabled
Whether deletion protection is enabled/disabled for the index.
Response
Section titled “Response”202 — The request to configure the index has been accepted. Check the index status to see when the change has been applied.
The IndexModel describes the configuration and status of a Pinecone index.
namestringrequiredThe name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length: 1 - 45. Example: example-index
dimensionintegerrequiredThe dimensions of the vectors to be inserted in the index.
Required range: 1 <= x <= 20000. Example: 1536
metricenum<string>requiredThe distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
Available options: cosine, euclidean, dotproduct
hoststringrequiredThe URL address where the index is hosted.
Example: semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io
deletion_protection?enum<string>Available options: disabled, enabled
Whether deletion protection is enabled/disabled for the index.
specobjectrequiredShow child attributes
pod?objectConfiguration needed to deploy a pod-based index.
Show child attributes
environmentstringrequiredThe environment where the index is hosted.
Example: us-east1-gcp
replicas?integerThe number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
Required range: 1 <= x
shards?integerThe number of shards. Shards split your data across multiple pods so you can fit more data into an index.
Required range: 1 <= x
pod_typestringrequiredThe type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
pods?integerThe number of pods to be used in the index. This should be equal to shards x replicas.'
Required range: 1 <= x. Example: 1
metadata_config?objectConfiguration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.
Show child attributes
indexed?string[]By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.
source_collection?stringThe name of the collection to be used as the source for the index.
Example: movie-embeddings
serverless?objectConfiguration needed to deploy a serverless index.
Show child attributes
cloudenum<string>requiredThe public cloud where you would like your index hosted.
Available options: gcp, aws, azure. Example: aws
regionstringrequiredThe region where you would like your index to be created.
Example: us-east-1
statusobjectrequiredShow child attributes
readybooleanrequiredstateenum<string>requiredAvailable options: Initializing, InitializationFailed, ScalingUp, ScalingDown, ScalingUpPodSize, ScalingDownPodSize, Terminating, Ready