Skip to main content
GET
/
restore-jobs
/
{job_id}
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

restore_job = pc.describe_restore_job(job_id="9857add2-99d4-4399-870e-aa7f15d8d326")

print(restore_job)

{'backup_id': '94a63aeb-efae-4f7a-b059-75d32c27ca57',
 'completed_at': datetime.datetime(2025, 4, 25, 18, 14, 11, 74618, tzinfo=tzutc()),
 'created_at': datetime.datetime(2025, 4, 25, 18, 14, 5, 227526, tzinfo=tzutc()),
 'percent_complete': 100.0,
 'restore_job_id': '9857add2-99d4-4399-870e-aa7f15d8d326',
 'status': 'Completed',
 'target_index_id': '0d8aed24-adf8-4b77-8e10-fd674309dc85',
 'target_index_name': 'restored-index'}

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

restore_job = pc.describe_restore_job(job_id="9857add2-99d4-4399-870e-aa7f15d8d326")

print(restore_job)

{'backup_id': '94a63aeb-efae-4f7a-b059-75d32c27ca57',
 'completed_at': datetime.datetime(2025, 4, 25, 18, 14, 11, 74618, tzinfo=tzutc()),
 'created_at': datetime.datetime(2025, 4, 25, 18, 14, 5, 227526, tzinfo=tzutc()),
 'percent_complete': 100.0,
 'restore_job_id': '9857add2-99d4-4399-870e-aa7f15d8d326',
 'status': 'Completed',
 'target_index_id': '0d8aed24-adf8-4b77-8e10-fd674309dc85',
 'target_index_name': 'restored-index'}

Authorizations

​
Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Path Parameters

​
job_id
string
required

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.

​
restore_job_id
string
required

Unique identifier for the restore job

Example:

"670e8400-e29b-41d4-a716-446655440001"

​
backup_id
string
required

Backup used for the restore

Example:

"670e8400-e29b-41d4-a716-446655440000"

​
target_index_name
string
required

Name of the index into which data is being restored

Example:

"sample-index"

​
target_index_id
string
required

ID of the index

Example:

"670e8400-e29b-41d4-a716-446655440002"

​
status
string
required

Status of the restore job

Example:

"Completed"

​
created_at
string<date-time>
required

Timestamp when the restore job started

Example:

"2025-02-04T13:00:00.000Z"

​
completed_at
string<date-time>

Timestamp when the restore job finished

Example:

"2025-02-04T14:00:00.000Z"

​
percent_complete
number<float>

The progress made by the restore job out of 100

Required range: 0 <= x <= 100
Example:

42.2