Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a backup

curl
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="8c85e612-ed1c-4f97-9f8c-8194e07bcf71"

curl -X GET "https://api.pinecone.io/backups/$BACKUP_ID" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2025-10" \
    -H "accept: application/json"
curl
{
  "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":98,
  "namespace_count":3,
  "size_bytes":1069169,
  "created_at":"2025-03-11T18:29:50.549505Z"
}

GET /backups/{backup_id}

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • backup_id (path, string, required) — The ID of the backup to describe.
  • 200 — Configuration information and deployment status of the backup.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Backup not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu