Skip to main content
PATCH
/
indexes
/
{index_name}
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"
)
{
    "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"
        }
    }
}
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"
)
{
    "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"
        }
    }
}

Authorizations

Api-Key
string
header
required

Path Parameters

index_name
string
required

Body

application/json
spec
object
deletion_protection
enum<string>
default:disabled
Available options:
disabled,
enabled

Response

name
string
required
Required string length: 1 - 45
Example:
dimension
integer
required
Required range: 1 <= x <= 20000
Example:
metric
enum<string>
default:cosine
required
Available options:
cosine,
euclidean,
dotproduct
host
string
required
Example:
spec
object
required
Example:
status
object
required
Example:
deletion_protection
enum<string>
default:disabled
Available options:
disabled,
enabled