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
List backups for all indexes in a project
List all backups for a project.
PINECONE_API_KEY="YOUR_API_KEY"
curl -X GET "https://api.pinecone.io/backups" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"data":
[
{
"backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
"source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
"source_index_name":"example-index-3",
"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"
},
{
"backup_id":"a65ff585-d987-4da5-a622-72e19a6ed5f4",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup-2",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:21:06.333375Z"
},
{
"backup_id":"b2703bbe-e348-4309-88db-dbf005d7c1bb",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:00:41.583538Z"
}
],
"pagination":null
}
PINECONE_API_KEY="YOUR_API_KEY"
curl -X GET "https://api.pinecone.io/backups" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"data":
[
{
"backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
"source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
"source_index_name":"example-index-3",
"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"
},
{
"backup_id":"a65ff585-d987-4da5-a622-72e19a6ed5f4",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup-2",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:21:06.333375Z"
},
{
"backup_id":"b2703bbe-e348-4309-88db-dbf005d7c1bb",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:00:41.583538Z"
}
],
"pagination":null
}
Authorizations
Response
The list of backups that exist in the project.
The BackupModel describes the configuration and status of a Pinecone backup.
Unique identifier for the backup.
"670e8400-e29b-41d4-a716-446655440001"
Name of the index from which the backup was taken.
"my-index"
ID of the index.
"670e8400-e29b-41d4-a716-446655440000"
Current status of the backup (e.g., Initializing, Ready, Failed).
"Ready"
Cloud provider where the backup is stored.
"aws"
Cloud region where the backup is stored.
"us-east-1"
Optional user-defined name for the backup.
"backup-2025-02-04"
Optional description providing context for the backup.
"Backup before bulk update."
The dimensions of the vectors to be inserted in the index.
1 <= x <= 20000
1536
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'.
cosine
, euclidean
, dotproduct
Total number of records in the backup.
120000
Number of namespaces in the backup.
3
Size of the backup in bytes.
10000000
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.
{ "tag0": "val0", "tag1": "val1" }
Timestamp when the backup was created.
Was this page helpful?
PINECONE_API_KEY="YOUR_API_KEY"
curl -X GET "https://api.pinecone.io/backups" \
-H "Api-Key: $PINECONE_API_KEY" \
-H "X-Pinecone-API-Version: 2025-04" \
-H "accept: application/json"
{
"data":
[
{
"backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
"source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
"source_index_name":"example-index-3",
"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"
},
{
"backup_id":"a65ff585-d987-4da5-a622-72e19a6ed5f4",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup-2",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:21:06.333375Z"
},
{
"backup_id":"b2703bbe-e348-4309-88db-dbf005d7c1bb",
"source_index_id":"1d724c1f-7a1f-469f-8514-4da2bc6e8b09",
"source_index_name":"example-index",
"tags":null,
"name":"example-backup",
"description":null,
"status":"Completed",
"cloud":"aws",
"region":"us-east-1",
"dimension":1024,
"record_count":350690,
"namespace_count":null,
"size_bytes":2038652848,
"created_at":"2025-03-07T17:00:41.583538Z"
}
],
"pagination":null
}