Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

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.

Python
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"
)
JavaScript
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' });
Java
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);
    }
}
Go
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)
    }
}
C#
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,
});
curl
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"
        }'
curl
{
    "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}

Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

index_namestringrequired

The name of the index to configure.

Typestring

The desired pod size and replica configuration for the index.

spec?object
Show child attributes
podobjectrequired
Show child attributes
replicas?integer

The 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

Typeinteger
Default1
pod_type?string

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

Typestring
Defaultp1.x1
deletion_protection?enum<string>

Available options: disabled, enabled

Typeenum<string>
Defaultdisabled

Whether deletion protection is enabled/disabled for the index.

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.

namestringrequired

The 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

Typestring
dimensionintegerrequired

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000. Example: 1536

Typeinteger
metricenum<string>required

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Available options: cosine, euclidean, dotproduct

Typeenum<string>
Defaultcosine
hoststringrequired

The URL address where the index is hosted.

Example: semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io

Typestring
deletion_protection?enum<string>

Available options: disabled, enabled

Typeenum<string>
Defaultdisabled

Whether deletion protection is enabled/disabled for the index.

specobjectrequired
Show child attributes
pod?object

Configuration needed to deploy a pod-based index.

Typeobject
Show child attributes
environmentstringrequired

The environment where the index is hosted.

Example: us-east1-gcp

Typestring
replicas?integer

The 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

Typeinteger
Default1
shards?integer

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

Required range: 1 <= x

Typeinteger
Default1
pod_typestringrequired

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

Typestring
Defaultp1.x1
pods?integer

The number of pods to be used in the index. This should be equal to shards x replicas.'

Required range: 1 <= x. Example: 1

Typeinteger
Default1
metadata_config?object

Configuration 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.

Typeobject
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.

Typestring[]
source_collection?string

The name of the collection to be used as the source for the index.

Example: movie-embeddings

Typestring
serverless?object

Configuration needed to deploy a serverless index.

Typeobject
Show child attributes
cloudenum<string>required

The public cloud where you would like your index hosted.

Available options: gcp, aws, azure. Example: aws

Typeenum<string>
regionstringrequired

The region where you would like your index to be created.

Example: us-east-1

Typestring
statusobjectrequired
Show child attributes
readybooleanrequired
stateenum<string>required

Available options: Initializing, InitializationFailed, ScalingUp, ScalingDown, ScalingUpPodSize, ScalingDownPodSize, Terminating, Ready

Typeenum<string>
Suggest an edit

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

Export
Documentation menu