Describe a restore job

# pip install --upgrade pinecone
import os
from pinecone import Pinecone

pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])

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

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();

const restoreJob = await pc.restoreJobs.describe('9857add2-99d4-4399-870e-aa7f15d8d326');
console.log(restoreJob);

package main

import (
    "context"
    "encoding/json"
    "fmt"
    "log"
    "os"

    "github.com/pinecone-io/go-pinecone/v7/pinecone"
)

func main() {
    ctx := context.Background()

    pc, err := pinecone.NewClient(pinecone.NewClientParams{
        ApiKey: os.Getenv("PINECONE_API_KEY"),
    })
    if err != nil {
        log.Fatalf("Failed to create Client: %v", err)
    }

    restoreJob, err := pc.DescribeRestoreJob(ctx, "9857add2-99d4-4399-870e-aa7f15d8d326")
    if err != nil {
        log.Fatalf("Failed to describe restore job: %v", err)
    }

    out, err := json.MarshalIndent(restoreJob, "", "  ")
    if err != nil {
        log.Fatalf("Failed to marshal response: %v", err)
    }
    fmt.Println(string(out))
}

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

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

Invalid API key

{
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Access denied: Permission control::backups::list is required"
  },
  "status": 403
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Restore job 670e8400-e29b-41d4-a716-446655440002 not found."
  },
  "status": 404
}

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

GET

restore-jobs

{job_id}

# pip install --upgrade pinecone
import os
from pinecone import Pinecone

pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])

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

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();

const restoreJob = await pc.restoreJobs.describe('9857add2-99d4-4399-870e-aa7f15d8d326');
console.log(restoreJob);

package main

import (
    "context"
    "encoding/json"
    "fmt"
    "log"
    "os"

    "github.com/pinecone-io/go-pinecone/v7/pinecone"
)

func main() {
    ctx := context.Background()

    pc, err := pinecone.NewClient(pinecone.NewClientParams{
        ApiKey: os.Getenv("PINECONE_API_KEY"),
    })
    if err != nil {
        log.Fatalf("Failed to create Client: %v", err)
    }

    restoreJob, err := pc.DescribeRestoreJob(ctx, "9857add2-99d4-4399-870e-aa7f15d8d326")
    if err != nil {
        log.Fatalf("Failed to describe restore job: %v", err)
    }

    out, err := json.MarshalIndent(restoreJob, "", "  ")
    if err != nil {
        log.Fatalf("Failed to marshal response: %v", err)
    }
    fmt.Println(string(out))
}

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

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

Invalid API key

{
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Access denied: Permission control::backups::list is required"
  },
  "status": 403
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Restore job 670e8400-e29b-41d4-a716-446655440002 not found."
  },
  "status": 404
}

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

# pip install --upgrade pinecone
import os
from pinecone import Pinecone

pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])

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

// npm install @pinecone-database/pinecone
import { Pinecone } from '@pinecone-database/pinecone';

// Reads PINECONE_API_KEY from the environment
const pc = new Pinecone();

const restoreJob = await pc.restoreJobs.describe('9857add2-99d4-4399-870e-aa7f15d8d326');
console.log(restoreJob);

package main

import (
    "context"
    "encoding/json"
    "fmt"
    "log"
    "os"

    "github.com/pinecone-io/go-pinecone/v7/pinecone"
)

func main() {
    ctx := context.Background()

    pc, err := pinecone.NewClient(pinecone.NewClientParams{
        ApiKey: os.Getenv("PINECONE_API_KEY"),
    })
    if err != nil {
        log.Fatalf("Failed to create Client: %v", err)
    }

    restoreJob, err := pc.DescribeRestoreJob(ctx, "9857add2-99d4-4399-870e-aa7f15d8d326")
    if err != nil {
        log.Fatalf("Failed to describe restore job: %v", err)
    }

    out, err := json.MarshalIndent(restoreJob, "", "  ")
    if err != nil {
        log.Fatalf("Failed to marshal response: %v", err)
    }
    fmt.Println(string(out))
}

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

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:2026-07

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.

Possible values: Pending, Completed, Failed, or Cancelled.

Example:

"Completed"

created_at

string<date-time> | null

required

Timestamp when the restore job started

Example:

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

completed_at

string<date-time> | null

Timestamp when the restore job finished. null until the job has completed.

Example:

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

percent_complete

integer<int32>

Progress 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

APIs

Database

Inference

Admin

SDKs

CLI

Tools

Authorizations

Headers

Path Parameters

Response