Skip to main content
POST
/
indexes
/
{index_name}
/
backups
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="docs-example"

curl "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H "X-Pinecone-Api-Version: 2025-10" \
    -d '{
      "name": "example-backup", 
      "description": "Monthly backup of production index"
      }'

{
  "backup_id":"8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "source_index_id":"f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Ready",
  "cloud":"aws",
  "region":"us-east-1",
  "dimension":1024,
  "record_count":96,
  "namespace_count":3,
  "size_bytes":1069169,
  "created_at":"2025-05-14T16:37:25.625540Z"
  }

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="docs-example"

curl "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H "X-Pinecone-Api-Version: 2025-10" \
    -d '{
      "name": "example-backup", 
      "description": "Monthly backup of production index"
      }'

{
  "backup_id":"8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "source_index_id":"f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Ready",
  "cloud":"aws",
  "region":"us-east-1",
  "dimension":1024,
  "record_count":96,
  "namespace_count":3,
  "size_bytes":1069169,
  "created_at":"2025-05-14T16:37:25.625540Z"
  }

Authorizations

​
Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Path Parameters

​
index_name
string
required

Name of the index to backup

Body

application/json

The desired configuration for the backup.

The configuration needed to create a backup of an index.

​
name
string

The name of the backup.

​
description
string

A description of the backup.

Response

The backup has been successfully created.

The BackupModel describes the configuration and status of a Pinecone backup.

​
backup_id
string
required

Unique identifier for the backup.

Example:

"670e8400-e29b-41d4-a716-446655440001"

​
source_index_name
string
required

Name of the index from which the backup was taken.

Example:

"my-index"

​
source_index_id
string
required

ID of the index.

Example:

"670e8400-e29b-41d4-a716-446655440000"

​
status
string
required

Current status of the backup (e.g., Initializing, Ready, Failed).

Example:

"Ready"

​
cloud
string
required

Cloud provider where the backup is stored.

Example:

"aws"

​
region
string
required

Cloud region where the backup is stored.

Example:

"us-east-1"

​
name
string

Optional user-defined name for the backup.

Example:

"backup-2025-02-04"

​
description
string

Optional description providing context for the backup.

Example:

"Backup before bulk update."

​
dimension
integer

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000
Example:

1536

​
metric
string

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'. Possible values: cosine, euclidean, or dotproduct.

​
schema
object

Schema for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when schema is present, only fields which are present in the fields object with a filterable: true are indexed. Note that filterable: false is not currently supported.

Example:
{
  "fields": {
    "description": { "filterable": true },
    "genre": { "filterable": true },
    "year": { "filterable": true }
  }
}
​
record_count
integer

Total number of records in the backup.

Example:

120000

​
namespace_count
integer

Number of namespaces in the backup.

Example:

3

​
size_bytes
integer

Size of the backup in bytes.

Example:

10000000

​
tags
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.

Example:
{ "tag0": "val0", "tag1": "val1" }
​
created_at
string

Timestamp when the backup was created.