Configure an index
This operation configures an existing index.
For serverless indexes, you can configure only index deletion protection. For pod-based indexes, you can configure the pod size, number of replicas, and index deletion protection.
It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then create a new pod-based index with a different pod type from the collection. For guidance and examples, see Configure an index.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Path Parameters
The name of the index to configure.
Body
Whether deletion protection is enabled/disabled for the index.
disabled, enabled Response
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 '-'.
The dimensions of the vectors to be inserted in the index.
The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
cosine, euclidean, dotproduct The URL address where the index is hosted.
Whether deletion protection is enabled/disabled for the index.
disabled, enabled Was this page helpful?