PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="9857add2-99d4-4399-870e-aa7f15d8d326"
curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
-H "X-Pinecone-Api-Version: 2026-07" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'accept: application/json'
{
"restore_job_id": "670e8400-e29b-41d4-a716-446655440001",
"backup_id": "670e8400-e29b-41d4-a716-446655440000",
"target_index_name": "sample-index",
"target_index_id": "670e8400-e29b-41d4-a716-446655440002",
"status": "Completed",
"created_at": "2025-02-04T13:00:00.000Z",
"completed_at": "2025-02-04T14:00:00.000Z",
"percent_complete": 100
}"Invalid API key"{
"error": {
"code": "PERMISSION_DENIED",
"message": "Access denied: Permission control::backups::list is required"
},
"status": 403
}{
"error": {
"code": "NOT_FOUND",
"message": "Restore job 670e8400-e29b-41d4-a716-446655440002 not found."
},
"status": 404
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}Describe a restore job
Get a description of a restore job.
PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="9857add2-99d4-4399-870e-aa7f15d8d326"
curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
-H "X-Pinecone-Api-Version: 2026-07" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'accept: application/json'
{
"restore_job_id": "670e8400-e29b-41d4-a716-446655440001",
"backup_id": "670e8400-e29b-41d4-a716-446655440000",
"target_index_name": "sample-index",
"target_index_id": "670e8400-e29b-41d4-a716-446655440002",
"status": "Completed",
"created_at": "2025-02-04T13:00:00.000Z",
"completed_at": "2025-02-04T14:00:00.000Z",
"percent_complete": 100
}"Invalid API key"{
"error": {
"code": "PERMISSION_DENIED",
"message": "Access denied: Permission control::backups::list is required"
},
"status": 403
}{
"error": {
"code": "NOT_FOUND",
"message": "Restore job 670e8400-e29b-41d4-a716-446655440002 not found."
},
"status": 404
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="9857add2-99d4-4399-870e-aa7f15d8d326"
curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
-H "X-Pinecone-Api-Version: 2026-07" \
-H "Api-Key: $PINECONE_API_KEY" \
-H 'accept: application/json'
Authorizations
Headers
Required date-based version header
Path Parameters
The ID of the restore job to describe.
Response
Configuration information and deployment status of the restore job.
The RestoreJobModel describes the status of a restore job.
Unique identifier for the restore job
"670e8400-e29b-41d4-a716-446655440001"
Backup used for the restore
"670e8400-e29b-41d4-a716-446655440000"
Name of the index into which data is being restored
"sample-index"
ID of the index
"670e8400-e29b-41d4-a716-446655440002"
Status of the restore job.
Possible values: Pending, Completed, Failed, or Cancelled.
"Completed"
Timestamp when the restore job started
"2025-02-04T13:00:00.000Z"
Timestamp when the restore job finished. null until the job has completed.
"2025-02-04T14:00:00.000Z"
Progress of the restore job: 100 once the job is Completed, absent while it is pending or after it has failed. Intermediate progress is not reported.
0 <= x <= 100100
Was this page helpful?