# Configure an index

For serverless indexes, you can configure only index deletion protection and tags. 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](/guides/using-pods-create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](/guides/using-pods-manage-pod-based-indexes).

```python Python theme={null}
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"
)
```

```javascript JavaScript theme={null}
import { Pinecone } from '@pinecone-database/pinecone'

const pinecone = new Pinecone({
  apiKey: 'YOUR_API_KEY'
});

await pinecone.configureIndex('docs-example', { 
    podType: 'p1.x2', 
    replicas: 4, 
    deletionProtection: 'enabled', 
    tags: { example: 'tag', environment: 'development' } 
});
```

```java Java theme={null}
import io.pinecone.clients.Pinecone;

public class ConfigureIndexExample {
    public static void main(String[] args) {
        Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();
        pc.configureIndex("docs-example", "p1.x2", 4, DeletionProtection.ENABLED);
    }
}
```

```go Go theme={null}
package main

import (
    "context"
    "fmt"
    "log"

    "github.com/pinecone-io/go-pinecone/v2/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{
        PodType: "p1.x2", 
        Replicas: 4, 
        DeletionProtection: "enabled",
        Tags: pinecone.IndexTags{
            "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 indexMetadata = await pinecone.ConfigureIndexAsync("docs-example", new ConfigureIndexRequest
{
    Spec = new ConfigureIndexRequestSpec
    {
        Pod = new ConfigureIndexRequestSpecPod {
            Replicas = 4,
            PodType = "p1.x2",
        }
    },
    DeletionProtection = DeletionProtection.Disabled,
});
```

```shell curl theme={null}
PINECONE_API_KEY="YOUR_API_KEY"

curl -s -X PATCH "https://api.pinecone.io/indexes/docs-example" \
    -H "Content-Type: application/json" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2024-10" \
    -d '{
            "spec": {
                "pod": {
                    "pod_type": "p1.x2",
                    "replicas": 4
                }
            },
            "deletion_protection": "disabled",
            "tags": {
                "example": "tag",
                "environment": "development"
            }
        }'
```

```json curl theme={null}
{
    "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"
        },
    "tags": {
            "example": "tag",
            "environment": "production"
        }
    }
}
```

`PATCH /indexes/{index_name}`

:::code-group
```bash title="cURL"
curl --request PATCH \
  --url https://api.pinecone.io/indexes/{index_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "spec": {
    "pod": {
      "replicas": 123,
      "pod_type": "<string>"
    }
  },
  "deletion_protection": "disabled",
  "tags": {
    "tag0": "val0",
    "tag1": "val1"
  }
}'
```

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

## Authorizations

- `Authorization` (header, string, required) — Bearer authentication header of the form `Bearer <token>`.

## Path Parameters

- `index_name` (path, string, required) — The name of the index to configure.

## Body

- `spec` (body, object)
- `deletion_protection` (body, string) — Whether [deletion protection](/guides/manage-data-manage-indexes#configure-deletion-protection) is enabled/disabled for the index.
- `tags` (body, object) — 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.

## Response

- `202` — The request to configure the index has been accepted. Check the index status to see when the change has been applied.
- `400` — Bad request. The request body included invalid request parameters.
- `401` — Unauthorized. Possible causes: Invalid API key.
- `402` — Payment required. Organization is on a paid plan and is delinquent on payment.
- `403` — You've exceed your pod quota.
- `404` — Index not found.
- `422` — Unprocessable entity. The request body could not be deserialized.
- `500` — Internal server error.

## Related pages

- [List indexes](./database-2026-07-control-plane-list-indexes.md)
- [Create an index](./database-2026-07-control-plane-create-index.md)
- [Create an index with integrated embedding](./database-2026-07-control-plane-create-for-model.md)
- [Describe an index](./database-2026-07-control-plane-describe-index.md)
- [Delete an index](./database-2026-07-control-plane-delete-index.md)
- [Configure an index](./database-2026-07-control-plane-configure-index.md)
- [Get index stats](./database-2026-07-data-plane-describeindexstats.md)
- [List indexes](./database-2026-04-control-plane-list-indexes.md)
- [Create an index](./database-2026-04-control-plane-create-index.md)
- [Create an index with integrated embedding](./database-2026-04-control-plane-create-for-model.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.