Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a restore job

Python
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)
JavaScript
import { Pinecone } from '@pinecone-database/pinecone';

const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' })

const restoreJob = await pc.describeRestoreJob('9857add2-99d4-4399-870e-aa7f15d8d326');

console.log(restoreJob);
Java
import io.pinecone.clients.Pinecone;
import org.openapitools.db_control.client.ApiException;
import org.openapitools.db_control.client.model.*;

public class CreateIndexFromBackup {
    public static void main(String[] args) throws ApiException {
        Pinecone pc = new Pinecone.Builder("YOUR_API-KEY").build();

        RestoreJobModel restoreJob = pc.describeRestoreJob("9857add2-99d4-4399-870e-aa7f15d8d326");

        System.out.println(restoreJob);
    }
}
Go
package main

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

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

func prettifyStruct(obj interface{}) string {
	bytes, _ := json.MarshalIndent(obj, "", "  ")
	return string(bytes)
}

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

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

	restoreJob, err := pc.DescribeRestoreJob(ctx, "e9ba8ff8-7948-4cfa-ba43-34227f6d30d4")
	if err != nil {
		log.Fatalf("Failed to describe restore job: %v", err)
	}

	fmt.Printf(prettifyStruct(restoreJob))
}
C#
using Pinecone;

var pinecone = new PineconeClient("YOUR_API_KEY");

var job = await pinecone.RestoreJobs.GetAsync("9857add2-99d4-4399-870e-aa7f15d8d326");

Console.WriteLine(job);
curl
PINECONE_API_KEY="YOUR_API_KEY"
JOB_ID="9857add2-99d4-4399-870e-aa7f15d8d326"

curl -X GET "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'
Python
{'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'}
JavaScript
{
  "restoreJobId": "9857add2-99d4-4399-870e-aa7f15d8d326",
  "backupId": "94a63aeb-efae-4f7a-b059-75d32c27ca57",
  "targetIndexName": "restored-index",
  "targetIndexId": "0d8aed24-adf8-4b77-8e10-fd674309dc85",
  "status": "Completed",
  "createdAt": "2025-04-25T18:14:05.227Z",
  "completedAt": "2025-04-25T18:14:11.074Z",
  "percentComplete": 100
}
Java
class RestoreJobModel {
    restoreJobId: cf597d76-4484-4b6c-b07c-2bfcac3388aa
    backupId: 0d75b99f-be61-4a93-905e-77201286c02e
    targetIndexName: restored-index
    targetIndexId: 0d8aed24-adf8-4b77-8e10-fd674309dc85
    status: Completed
    createdAt: 2025-05-16T20:09:18.700631Z
    completedAt: 2025-05-16T20:11:30.673296Z
    percentComplete: 100.0
    additionalProperties: null
}
Go
{
  "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "completed_at": "2025-05-16T20:11:30.673296Z",
  "created_at": "2025-05-16T20:09:18.700631Z",
  "percent_complete": 100,
  "restore_job_id": "e9ba8ff8-7948-4cfa-ba43-34227f6d30d4",
  "status": "Completed",
  "target_index_id": "025117b3-e683-423c-b2d1-6d30fbe5027f",
  "target_index_name": "restored-index"
}
C#
{
  "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
}
curl
{
  "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
}

GET /restore-jobs/{job_id}

  • job_id (path, string, required) — The ID of the restore job to describe.
  • 200 — Configuration information and deployment status of the restore job.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Restore job not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu