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-04" \
    -d '{
      "name": "example-backup", 
      "description": "Monthly backup of production index"
      }'

{
  "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
  "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Pending",
  "cloud":"aws",
  "region":"us-east-1",
  "dimension":null,
  "record_count":null,
  "namespace_count":null,
  "size_bytes":null,
  "created_at":"2025-03-11T18:29:50.549482312Z"
  }

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-04" \
    -d '{
      "name": "example-backup", 
      "description": "Monthly backup of production index"
      }'

{
  "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
  "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Pending",
  "cloud":"aws",
  "region":"us-east-1",
  "dimension":null,
  "record_count":null,
  "namespace_count":null,
  "size_bytes":null,
  "created_at":"2025-03-11T18:29:50.549482312Z"
  }

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.

Response

201
application/json

The backup has been successfully created.

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