List restore jobs
List all restore jobs for a project.
PINECONE_API_KEY="YOUR_API_KEY"
curl "https://api.pinecone.io/restore-jobs" \
-H "X-Pinecone-Api-Version: 2026-07" \
-H "Api-Key: $PINECONE_API_KEY"GET /restore-jobs
{
"data": [
{
"backup_id": "670e8400-e29b-41d4-a716-446655440000",
"completed_at": "2024-03-15T10:35:00.000Z",
"created_at": "2024-03-15T10:30:00.000Z",
"percent_complete": 100,
"restore_job_id": "670e8400-e29b-41d4-a716-446655440001",
"status": "Completed",
"target_index_id": "idx_456",
"target_index_name": "my-index"
}
],
"pagination": {
"next": "dXNlcl9pZD11c2VyXzE="
}
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Bad request. The request body included invalid request parameters."
},
"status": 400
}{
"error": {
"code": "PERMISSION_DENIED",
"message": "Access denied: Permission control::backups::list is required"
},
"status": 403
}{
"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
Query Parameters
Section titled “Query Parameters”limit?integerThe number of results to return per page.
paginationToken?stringThe token to use to retrieve the next page of results. A malformed token is rejected with 400.
Response
Section titled “Response”200 — This operation returns a list of all the restore jobs that you have previously created.
The list of restore jobs that exist in the project.
dataobject[]requiredList of restore job objects
Show child attributes
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
pagination?object | nullCursor envelope for the next page. null (or absent) on the final page of results.
Show child attributes
nextstringrequiredThe token to use to retrieve the next page of results.
Example: dXNlcl9pZD11c2VyXzE=