PATCH
/
indexes
/
{index_name}
PINECONE_API_KEY = "YOUR_API_KEY"

curl -s -X PATCH "https://api.pinecone.io/indexes/example-index" \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -d '{
         "pod_type": "s1.x2",
         "replicas": 4
      }'

{
  "name": "example-index",
  "dimension": 1536,
  "metric": "cosine",
  "host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
  "spec": {
    "pod": {
      "environment": "us-east-1-aws",
      "replicas": 1,
      "shards": 1,
      "pod_type": "p1.x1",
      "pods": 1,
      "metadata_config": {
        "indexed": [
          "genre",
          "title",
          "imdb_rating"
        ]
      }
    }
  },
  "status": {
    "ready": true,
    "state": "ScalingUpPodSize"
  }
}
PINECONE_API_KEY = "YOUR_API_KEY"

curl -s -X PATCH "https://api.pinecone.io/indexes/example-index" \
  -H "Content-Type: application/json" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -d '{
         "pod_type": "s1.x2",
         "replicas": 4
      }'

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
index_name
string
required

The name of the index to configure.

Body

application/json

The desired pod type and replica configuration for the index.

Configuration used to scale an index.

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.