> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Configure an index
> Configure an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, 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](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes).
```python Python theme={null}
from pinecone import Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")
pc.configure_index(
name="docs-example",
deletion_protection="enabled",
tags={"example": "tag", "environment": "development"}
)
```
```javascript JavaScript theme={null}
import { Pinecone } from '@pinecone-database/pinecone'
const pinecone = new Pinecone({ apiKey: 'YOUR_API_KEY' });
await pinecone.configureIndex(
'docs-example',
{
deletionProtection: 'enabled',
tags: {
example: 'tag',
environment: 'development'
}
}
);
```
```java Java theme={null}
import io.pinecone.clients.Pinecone;
import org.openapitools.db_control.client.model.*;
import java.util.HashMap;
public class ConfigureIndexExample {
public static void main(String[] args) throws Exception {
Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
HashMap tags = new HashMap<>();
tags.put("example", "tag");
tags.put("environment", "development");
IndexModel indexList = pc.configureServerlessIndex(
"docs-example",
DeletionProtection.ENABLED,
tags,
null
);
}
}
```
```go Go theme={null}
package main
import (
"context"
"fmt"
"log"
"github.com/pinecone-io/go-pinecone/v4/pinecone"
)
func main() {
ctx := context.Background()
pc, err := pinecone.NewClient(pinecone.NewClientParams{
ApiKey: "YOUR_API_KEY",
})
if err != nil {
log.Fatalf("Failed to create Client: %v", err)
}
idx, err := pc.ConfigureIndex(ctx, "docs-example", pinecone.ConfigureIndexParams{
DeletionProtection: "enabled",
Tags: map[string]string{
"example": "tag",
"environment": "development",
},
})
if err != nil {
log.Fatalf("Failed to configure index \"%v\": %v", idx.Name, err)
} else {
fmt.Printf("Successfully configured index \"%v\"", idx.Name)
}
}
```
```csharp C# theme={null}
using Pinecone;
var pinecone = new PineconeClient("YOUR_API_KEY");
var request = new ConfigureIndexRequest
{
DeletionProtection = DeletionProtection.Enabled,
Tags = new Dictionary
{
{ "example", "tag" },
{ "environment", "development" }
}
};
var index = await pinecone.ConfigureIndexAsync("docs-example", request);
```
```shell curl theme={null}
PROJECT_NAME="YOUR_PROJECT_NAME"
PINECONE_API_KEY="YOUR_API_KEY"
curl -X PATCH "https://api.pinecone.io/indexes/$INDEX_NAME" \
-H "Content-Type: application/json" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-Api-Version: 2025-04" \
-d '{
"deletion_protection": "enabled",
"tags": {
"example": "tag",
"environment": "development"
}
}'
```
```bash CLI theme={null}
# Target the project that contains the index you'd
# like to configure.
pc target -o "example-org" -p "example-project"
# Configure the index.
pc index configure \
--name "docs-example" \
--deletion_protection "enabled"
```
```json Response theme={null}
{
"name": "docs-example",
"vector_type": "dense",
"metric": "cosine",
"dimension": 1536,
"status": {
"ready": true,
"state": "Ready"
},
"host": "docs-example-1c6ab6aa.svc.aped-4627-b74a.pinecone.io",
"spec": {
"serverless": {
"region": "us-east-1",
"cloud": "aws"
}
},
"deletion_protection": "enabled",
"tags": {
"environment": "development",
"example": "tag"
}
}
```
## OpenAPI
````yaml https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2025-04/db_control_2025-04.oas.yaml patch /indexes/{index_name}
openapi: 3.0.3
info:
title: Pinecone Control Plane API
description: >-
Pinecone is a vector database that makes it easy to search and retrieve
billions of high-dimensional vectors.
contact:
name: Pinecone Support
url: https://support.pinecone.io
email: support@pinecone.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 2025-04
servers:
- url: https://api.pinecone.io
description: Production API endpoints
security:
- ApiKeyAuth: []
tags:
- name: Manage Indexes
description: Actions that manage indexes
externalDocs:
description: More Pinecone.io API docs
url: https://docs.pinecone.io/introduction
paths:
/indexes/{index_name}:
patch:
tags:
- Manage Indexes
summary: Configure an index
description: >-
Configure an existing index. For serverless indexes, you can configure
index deletion protection, tags, and integrated inference embedding
settings for the index. For pod-based indexes, you can configure the pod
size, number of replicas, tags, 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](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection)
from the collection. For guidance and examples, see [Configure an
index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes).
operationId: configure_index
parameters:
- in: path
name: index_name
description: The name of the index to configure.
required: true
schema:
type: string
example: test-index
style: simple
requestBody:
description: The desired pod size and replica configuration for the index.
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureIndexRequest'
examples:
vertical-scaling:
summary: Vertical scaling with pod size
value:
spec:
pod:
pod_type: p1.x2
horizontal-scaling:
summary: Horizontal scaling with replicas
value:
spec:
pod:
replicas: 4
scaling-both:
summary: Scaling both pod size and number of replicas
value:
spec:
pod:
pod_type: p1.x2
replicas: 4
disable-deletion-protection:
summary: Disable deletion protection for the index
value:
delete_protection: disabled
update-index-tags:
summary: Update tag0 and delete tag1
value:
tags:
tag0: new-val
tag1: ''
required: true
responses:
'202':
description: >-
The request to configure the index has been accepted. Check the
index status to see when the change has been applied.
content:
application/json:
schema:
$ref: '#/components/schemas/IndexModel'
'400':
description: Bad request. The request body included invalid request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
index-metric-validation-error:
summary: Validation error
value:
error:
code: INVALID_ARGUMENT
message: >-
Bad request. The request body included invalid request
parameters.
status: 400
'401':
description: 'Unauthorized. Possible causes: Invalid API key.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
unauthorized:
summary: Unauthorized
value:
error:
code: UNAUTHENTICATED
message: Invalid API key.
status: 401
'402':
description: >-
Payment required. Organization is on a paid plan and is delinquent
on payment.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
payment-required:
summary: Payment required
value:
error:
code: PAYMENT_REQUIRED
message: >-
Request failed. Pay all past due invoices to lift
restrictions on your account.
status: 402
'403':
description: You've exceed your pod quota.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
unauthorized:
summary: Forbidden
value:
error:
code: FORBIDDEN
message: Increase your quota or upgrade to create more indexes.
status: 403
'404':
description: Index not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
index-not-found:
summary: Index not found
value:
error:
code: NOT_FOUND
message: Index example-index not found.
status: 404
'422':
description: Unprocessable entity. The request body could not be deserialized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
missing-field:
summary: Unprocessable entity
value:
error:
code: UNPROCESSABLE_ENTITY
message: >-
Failed to deserialize the JSON body into the target
type: missing field `metric` at line 1 column 16
status: 422
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
internal-server-error:
summary: Internal server error
value:
error:
code: UNKNOWN
message: Internal server error
status: 500
components:
schemas:
ConfigureIndexRequest:
description: Configuration used to scale an index.
type: object
properties:
spec:
type: object
properties:
pod:
type: object
properties:
replicas:
description: >-
The number of replicas. Replicas duplicate your index. They
provide higher availability and throughput. Replicas can be
scaled up or down as your needs change.
default: 1
type: integer
format: int32
minimum: 1
pod_type:
description: >-
The type of pod to use. One of `s1`, `p1`, or `p2` appended
with `.` and one of `x1`, `x2`, `x4`, or `x8`.
default: p1.x1
type: string
required:
- pod
deletion_protection:
$ref: '#/components/schemas/DeletionProtection'
tags:
$ref: '#/components/schemas/IndexTags'
embed:
example:
field_map:
text: your-text-field
model: multilingual-e5-large
read_parameters:
input_type: query
truncate: NONE
write_parameters:
input_type: passage
description: >-
Configure the integrated inference embedding settings for this
index.
You can convert an existing index to an integrated index by
specifying the embedding model and field_map. The index vector type
and dimension must match the model vector type and dimension, and
the index similarity metric must be supported by the model. Refer to
the [model
guide](https://docs.pinecone.io/guides/index-data/create-an-index#embedding-models)
for available models and model details.
You can later change the embedding configuration to update the field
map, read parameters, or write parameters. Once set, the model
cannot be changed.
type: object
properties:
model:
example: multilingual-e5-large
description: >-
The name of the embedding model to use with the index. The index
dimension and model dimension must match, and the index
similarity metric must be supported by the model. The index
embedding model cannot be changed once set.
type: string
field_map:
example:
text: your-text-field
description: >-
Identifies the name of the text field from your document model
that will be embedded.
type: object
read_parameters:
description: The read parameters for the embedding model.
type: object
write_parameters:
description: The write parameters for the embedding model.
type: object
IndexModel:
description: >-
The IndexModel describes the configuration and status of a Pinecone
index.
type: object
properties:
name:
example: example-index
description: >
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 '-'.
type: string
minLength: 1
maxLength: 45
dimension:
example: 1536
description: The dimensions of the vectors to be inserted in the index.
type: integer
format: int32
minimum: 1
maximum: 20000
metric:
description: >-
The distance metric to be used for similarity search. You can use
'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is
'sparse', the metric must be 'dotproduct'. If the `vector_type` is
`dense`, the metric defaults to 'cosine'.
type: string
enum:
- cosine
- euclidean
- dotproduct
host:
example: semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io
description: The URL address where the index is hosted.
type: string
private_host:
example: semantic-search-c01b5b5.svc.private.us-west1-gcp.pinecone.io
description: The private endpoint URL of an index.
type: string
deletion_protection:
$ref: '#/components/schemas/DeletionProtection'
tags:
$ref: '#/components/schemas/IndexTags'
embed:
$ref: '#/components/schemas/ModelIndexEmbed'
spec:
example:
pod:
environment: us-east-1-aws
metadata_config:
indexed:
- genre
- title
- imdb_rating
pod_type: p1.x1
pods: 1
replicas: 1
shards: 1
type: object
properties:
byoc:
$ref: '#/components/schemas/ByocSpec'
pod:
$ref: '#/components/schemas/PodSpec'
serverless:
$ref: '#/components/schemas/ServerlessSpec'
status:
example:
ready: true
state: ScalingUpPodSize
type: object
properties:
ready:
type: boolean
state:
type: string
enum:
- Initializing
- InitializationFailed
- ScalingUp
- ScalingDown
- ScalingUpPodSize
- ScalingDownPodSize
- Terminating
- Ready
- Disabled
required:
- ready
- state
vector_type:
description: >-
The index vector type. You can use 'dense' or 'sparse'. If 'dense',
the vector dimension must be specified. If 'sparse', the vector
dimension should not be specified.
default: dense
type: string
required:
- name
- metric
- status
- spec
- host
- vector_type
ErrorResponse:
example:
error:
code: QUOTA_EXCEEDED
message: >-
The index exceeds the project quota of 5 pods by 2 pods. Upgrade
your account or change the project settings to increase the quota.
status: 429
description: The response shape used for all error responses.
type: object
properties:
status:
example: 500
description: The HTTP status code of the error.
type: integer
error:
example:
code: INVALID_ARGUMENT
message: >-
Index name must contain only lowercase alphanumeric characters or
hyphens, and must not begin or end with a hyphen.
description: Detailed information about the error that occurred.
type: object
properties:
code:
type: string
enum:
- OK
- UNKNOWN
- INVALID_ARGUMENT
- DEADLINE_EXCEEDED
- QUOTA_EXCEEDED
- NOT_FOUND
- ALREADY_EXISTS
- PERMISSION_DENIED
- UNAUTHENTICATED
- RESOURCE_EXHAUSTED
- FAILED_PRECONDITION
- ABORTED
- OUT_OF_RANGE
- UNIMPLEMENTED
- INTERNAL
- UNAVAILABLE
- DATA_LOSS
- FORBIDDEN
- UNPROCESSABLE_ENTITY
- PAYMENT_REQUIRED
message:
example: >-
Index name must contain only lowercase alphanumeric characters
or hyphens, and must not begin or end with a hyphen.
type: string
details:
description: >-
Additional information about the error. This field is not
guaranteed to be present.
type: object
required:
- code
- message
required:
- status
- error
DeletionProtection:
description: >
Whether [deletion
protection](http://docs.pinecone.io/guides/manage-data/manage-indexes#configure-deletion-protection)
is enabled/disabled for the index.
default: disabled
type: string
enum:
- disabled
- enabled
IndexTags:
example:
tag0: val0
tag1: val1
description: >-
Custom user tags added to an index. Keys must be 80 characters or less.
Values must be 120 characters or less. Keys must be alphanumeric, '_',
or '-'. Values must be alphanumeric, ';', '@', '_', '-', '.', '+', or '
'. To unset a key, set the value to be an empty string.
type: object
additionalProperties:
type: string
ModelIndexEmbed:
example:
field_map:
text: your-text-field
metric: cosine
model: multilingual-e5-large
read_parameters:
input_type: query
truncate: NONE
write_parameters:
input_type: passage
description: The embedding model and document fields mapped to embedding inputs.
type: object
properties:
model:
example: multilingual-e5-large
description: The name of the embedding model used to create the index.
type: string
metric:
description: >-
The distance metric to be used for similarity search. You can use
'euclidean', 'cosine', or 'dotproduct'. If not specified, the metric
will be defaulted according to the model. Cannot be updated once
set.
type: string
enum:
- cosine
- euclidean
- dotproduct
dimension:
example: 1536
description: The dimensions of the vectors to be inserted in the index.
type: integer
format: int32
minimum: 1
maximum: 20000
vector_type:
description: >-
The index vector type. You can use 'dense' or 'sparse'. If 'dense',
the vector dimension must be specified. If 'sparse', the vector
dimension should not be specified.
default: dense
type: string
field_map:
example:
text: your-text-field
description: >-
Identifies the name of the text field from your document model that
is embedded.
type: object
read_parameters:
description: The read parameters for the embedding model.
type: object
write_parameters:
description: The write parameters for the embedding model.
type: object
required:
- model
ByocSpec:
example:
environment: aws-us-east-1-b921
description: Configuration needed to deploy an index in a BYOC environment.
type: object
properties:
environment:
example: aws-us-east-1-b921
description: The environment where the index is hosted.
type: string
required:
- environment
PodSpec:
example:
environment: us-east1-gcp
metadata_config:
indexed:
- genre
- title
- imdb_rating
pod_type: p1.x1
pods: 1
replicas: 1
shards: 1
source_collection: movie-embeddings
description: Configuration needed to deploy a pod-based index.
type: object
properties:
environment:
example: us-east1-gcp
description: The environment where the index is hosted.
type: string
replicas:
description: >-
The number of replicas. Replicas duplicate your index. They provide
higher availability and throughput. Replicas can be scaled up or
down as your needs change.
default: 1
type: integer
format: int32
minimum: 1
shards:
description: >-
The number of shards. Shards split your data across multiple pods so
you can fit more data into an index.
default: 1
type: integer
format: int32
minimum: 1
pod_type:
description: >-
The type of pod to use. One of `s1`, `p1`, or `p2` appended with `.`
and one of `x1`, `x2`, `x4`, or `x8`.
default: p1.x1
type: string
pods:
example: 1
description: >-
The number of pods to be used in the index. This should be equal to
`shards` x `replicas`.'
default: 1
type: integer
minimum: 1
metadata_config:
example:
indexed:
- genre
- title
- imdb_rating
description: >-
Configuration for the behavior of Pinecone's internal metadata
index. By default, all metadata is indexed; when `metadata_config`
is present, only specified metadata fields are indexed. These
configurations are only valid for use with pod-based indexes.
type: object
properties:
indexed:
description: >-
By default, all metadata is indexed; to change this behavior,
use this property to specify an array of metadata fields that
should be indexed.
type: array
items:
type: string
source_collection:
example: movie-embeddings
description: The name of the collection to be used as the source for the index.
type: string
required:
- environment
- pod_type
ServerlessSpec:
description: Configuration needed to deploy a serverless index.
type: object
properties:
cloud:
example: aws
description: The public cloud where you would like your index hosted.
type: string
enum:
- gcp
- aws
- azure
region:
example: us-east-1
description: The region where you would like your index to be created.
type: string
source_collection:
type: string
description: The name of the collection to be used as the source for the index.
required:
- cloud
- region
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Api-Key
description: >-
An API Key is required to call Pinecone APIs. Get yours from the
[console](https://app.pinecone.io/).
````