PATCH
/
indexes
/
{index_name}
curl --request PATCH \
  --url https://api.pinecone.io/indexes/{index_name} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "spec": {
    "pod": {
      "pod_type": "p1.x2"
    }
  }
}'

Authorizations

Api-Key
string
headerrequired

Path Parameters

index_name
string
required

The name of the index to configure.

Body

application/json

Configuration used to scale an index.

spec
object
required

Response

202 - application/json

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: cosinerequired

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

Available options:
cosine,
euclidean,
dotproduct
spec
object
required
status
object
required
host
string

The URL address where the index is hosted.

Was this page helpful?