PATCH
/
indexes
/
{index_name}
from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
    name="example-index", 
    pod_type="p1.x2", 
    replicas=4,
    deletion_protection="enabled"
)

{
    "name": "example-index",
    "metric": "cosine",
    "dimension": 1536,
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "host": "example-index1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
    "spec": {
        "serverless": {
            "region": "us-east-1",
            "cloud": "aws"
        }
    }
}

from pinecone.grpc import PineconeGRPC as Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.configure_index(
    name="example-index", 
    pod_type="p1.x2", 
    replicas=4,
    deletion_protection="enabled"
)

{
    "name": "example-index",
    "metric": "cosine",
    "dimension": 1536,
    "status": {
        "ready": true,
        "state": "Ready"
    },
    "host": "example-index1-4zo0ijk.svc.dev-us-west2-aws.pinecone.io",
    "spec": {
        "serverless": {
            "region": "us-east-1",
            "cloud": "aws"
        }
    }
}

Path Parameters

​
index_name
string
required

The name of the index to configure.

Body

application/json
The desired pod size and replica configuration for the index.

Configuration used to scale an index.

​
spec
object
​
deletion_protection
enum<string>
default:
disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled

Response

202
application/json
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.

​
name
string
required

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
​
dimension
integer
required

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

Required range: 1 < x < 20000
​
metric
enum<string>
default:
cosine
required

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

Available options:
cosine,
euclidean,
dotproduct
​
host
string
required

The URL address where the index is hosted.

​
spec
object
required
​
status
object
required
​
deletion_protection
enum<string>
default:
disabled

Whether deletion protection is enabled/disabled for the index.

Available options:
disabled,
enabled

Was this page helpful?