Describe a restore job - Pinecone Docs

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: 2025-10" \ -H "Api-Key: $PINECONE_API_KEY" \ -H 'accept: application/json'

{ "restore_job_id": "9857add2-99d4-4399-870e-aa7f15d8d326", "backup_id": "94a63aeb-efae-4f7a-b059-75d32c27ca57", "target_index_name": "restored-index", "target_index_id": "0d8aed24-adf8-4b77-8e10-fd674309dc85", "status": "Completed", "created_at": "2025-04-25T18:14:05.227526Z", "completed_at": "2025-04-25T18:14:11.074618Z", "percent_complete": 100 }

Authorizations

Api-Key

string

header

required

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

Headers

X-Pinecone-Api-Version

string

default:2025-10

required

Required date-based version header

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