v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB

Manage Indexes

Describe a restore job

Get a description of a restore job.

get/restore-jobs/{job_id}

Path parameters

job_idstring required

The ID of the restore job to describe.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

Configuration information and deployment status of the restore job.

restore_job_idstring required

Unique identifier for the restore job

backup_idstring required

Backup used for the restore

target_index_namestring required

Name of the index into which data is being restored

target_index_idstring required

ID of the index

statusstring required

Status of the restore job

created_atstring date-time required

Timestamp when the restore job started

completed_atstring date-time

Timestamp when the restore job finished

percent_completenumber float

The progress made by the restore job out of 100

Example response

{
  "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": 42.2
}