Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Configure an index

This operation configures the pod size and number of replicas for a pod-based index.

It is not possible to change the pod type of an index. However, you can create a collection from an index and then create a new index with a different pod type from the collection.

Python
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
   name="docs-example", 
   deletion_protection="disabled"
)
JavaScript
import { Pinecone } from '@pinecone-database/pinecone';

const client = new Pinecone({ apiKey: 'YOUR_API_KEY' });

await client.configureIndex('docs-example', { deletionProtection: 'disabled' });
Java
import io.pinecone.clients.Pinecone;
import org.openapitools.db_control.client.model.*;

public class ConfigureIndexExample {
    public static void main(String[] args) {
        Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
        pc.configurePodsIndex("docs-example", DeletionProtection.DISABLED);
    }
}
Go
package main

import (
    "context"
    "fmt"
    "log"

    "github.com/pinecone-io/go-pinecone/v3/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{DeletionProtection: "disabled"})
  	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 configureIndexRequest = await pinecone.ConfigureIndexAsync("docs-example", new ConfigureIndexRequest
{
    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: 2025-04" \
    -d '{
        "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"
        },
    "tags": {
            "example": "tag",
            "environment": "production"
        }
    },
    "deletion_protection": "disabled"
}

PATCH /indexes/{index_name}

  • index_name (path, string, required) — The name of the index to configure.
  • spec (body, object, required)
  • 202 — The request to configure the index has been accepted. Check the index status to see when the change has been applied.
  • 400
  • 401
  • 403
  • 404
  • 422
  • 500
Suggest an edit

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

Export
Documentation menu