GET
/
restore-jobs
/
{job_id}
PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="e9ba8ff8-7948-4cfa-ba43-34227f6d30d4"

curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
    -H "X-Pinecone-Api-Version: 2025-04" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json'

{
    "data":
    [
        {
            "restore_job_id":"e9ba8ff8-7948-4cfa-ba43-34227f6d30d4",
            "backup_id":"a65ff585-d987-4da5-a622-72e19a6ed5f4",
            "target_index_name":"restored-index",
            "target_index_id":"025117b3-e683-423c-b2d1-6d30fbe5027f",
            "status":"Completed",
            "created_at":"2025-03-11T18:50:19.770696Z",
            "completed_at":"2025-03-11T18:51:37.872620Z",
            "percent_complete":100
        },
    ]
}

PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="e9ba8ff8-7948-4cfa-ba43-34227f6d30d4"

curl "https://api.pinecone.io/restore-jobs/$JOB_ID" \
    -H "X-Pinecone-Api-Version: 2025-04" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json'

{
    "data":
    [
        {
            "restore_job_id":"e9ba8ff8-7948-4cfa-ba43-34227f6d30d4",
            "backup_id":"a65ff585-d987-4da5-a622-72e19a6ed5f4",
            "target_index_name":"restored-index",
            "target_index_id":"025117b3-e683-423c-b2d1-6d30fbe5027f",
            "status":"Completed",
            "created_at":"2025-03-11T18:50:19.770696Z",
            "completed_at":"2025-03-11T18:51:37.872620Z",
            "percent_complete":100
        },
    ]
}

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

200
application/json
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
required

Timestamp when the restore job started

Example:

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

​
completed_at
string

Timestamp when the restore job finished

Example:

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

​
percent_complete
number

The progress made by the restore job out of 100

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

42.2

Was this page helpful?