Backups
Describe a backup
Database
- Indexes
- Namespaces
- Vectors
- Search
- Imports
- Backups
- POSTCreate a backup of an index
- GETList backups for all indexes in a project
- GETList backups for an index
- GETDescribe a backup
- DELDelete a backup
- POSTCreate an index from a backup
- GETList restore jobs
- GETDescribe a restore job
- GETList collections
- POSTCreate a collection
- GETDescribe a collection
- DELDelete a collection
- POST
Inference
- Embed
- Rerank
Admin
- API keys
- Projects
- Service accounts
Architecture
Backups
Describe a backup
Get a description of a backup.
GET
/
backups
/
{backup_id}
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="9947520e-d5a1-4418-a78d-9f464c9969da"
curl -X GET "https://api.pinecone.io/backups/$BACKUP_ID" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"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.549505Z"
}
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="9947520e-d5a1-4418-a78d-9f464c9969da"
curl -X GET "https://api.pinecone.io/backups/$BACKUP_ID" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"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.549505Z"
}
Authorizations
Path Parameters
The ID of the backup to describe.
Response
200
application/json
Configuration information and deployment status of the backup.
The BackupModel describes the configuration and status of a Pinecone backup.
Was this page helpful?
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="9947520e-d5a1-4418-a78d-9f464c9969da"
curl -X GET "https://api.pinecone.io/backups/$BACKUP_ID" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"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.549505Z"
}