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'GET /restore-jobs/{job_id}
{
"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
}{
"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
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Path Parameters
Section titled “Path Parameters”job_idstringrequiredThe ID of the restore job to describe.
Response
Section titled “Response”200 — Configuration information and deployment status of the restore job.
The RestoreJobModel describes the status of a restore job.
restore_job_idstringrequiredUnique identifier for the restore job
Example: 670e8400-e29b-41d4-a716-446655440001
backup_idstringrequiredBackup used for the restore
Example: 670e8400-e29b-41d4-a716-446655440000
target_index_namestringrequiredName of the index into which data is being restored
Example: sample-index
target_index_idstringrequiredID of the index
Example: 670e8400-e29b-41d4-a716-446655440002
statusstringrequiredStatus of the restore job. Possible values: Pending, Completed, Failed, or Cancelled.
Example: Completed
created_atstring | nullrequiredTimestamp when the restore job started
Example: 2025-02-04T13:00:00.000Z
completed_at?string | nullTimestamp when the restore job finished. null until the job has completed.
Example: 2025-02-04T14:00:00.000Z
percent_complete?integerProgress 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.
Required range: 0 <= x <= 100. Example: 100