Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

List restore jobs

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

restore_jobs = pc.list_restore_jobs()

print(restore_jobs)
JavaScript
import { Pinecone } from '@pinecone-database/pinecone';

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

const restoreJobs = await pc.listRestoreJobs();

console.log(restoreJobs);
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();

        // List all restore jobs with default pagination limit (100)
        RestoreJobList restoreJobList = pc.listRestoreJobs(null, null);

        // List all restore jobs with pagination limit of 2
        RestoreJobList restoreJobListWithLimit = pc.listRestoreJobs(null, 2);

        // List all restore jobs with pagination limit and token
        RestoreJobList restoreJobListPaginated = pc.listRestoreJobs("eyJza2lwX3Bhc3QiOiIxMDEwMy0=", 2);

        System.out.println(restoreJobListWithLimit);
    }
}
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)
	}

	limit := 2
	restoreJobs, err := pc.ListRestoreJobs(ctx, &pinecone.ListRestoreJobsParams{
		Limit: &limit,
	})
	if err != nil {
		log.Fatalf("Failed to list restore jobs: %v", err)
	}

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

var pinecone = new PineconeClient("YOUR_API_KEY");

var jobs = await pinecone.RestoreJobs.ListAsync(new ListRestoreJobsRequest());

Console.WriteLine(jobs);
curl
PINECONE_API_KEY="YOUR_API_KEY"

curl -X GET "https://api.pinecone.io/restore-jobs" \
     -H "X-Pinecone-Api-Version: 2025-04" \
     -H "Api-Key: $PINECONE_API_KEY"
Python
[{
    "restore_job_id": "06b08366-a0a9-404d-96c2-e791c71743e5",
    "backup_id": "95707edb-e482-49cf-b5a5-312219a51a97",
    "target_index_name": "restored-index",
    "target_index_id": "027aff93-de40-4f48-a573-6dbcd654f961",
    "status": "Completed",
    "created_at": "2025-05-15T13:59:51.439479+00:00",
    "completed_at": "2025-05-15T14:00:09.222998+00:00",
    "percent_complete": 100.0
}, {
    "restore_job_id": "4902f735-b876-4e53-a05c-bc01d99251cb",
    "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
    "target_index_name": "restored-index2",
    "target_index_id": "027aff93-de40-4f48-a573-6dbcd654f961",
    "status": "Completed",
    "created_at": "2025-05-15T21:06:19.906074+00:00",
    "completed_at": "2025-05-15T21:06:39.360509+00:00",
    "percent_complete": 100.0
}]
JavaScript
{
  "data": [
    {
      "restoreJobId": "69acc1d0-9105-4fcb-b1db-ebf97b285c5e",
      "backupId": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "targetIndexName": "restored-index2",
      "targetIndexId": "e6c0387f-33db-4227-9e91-32181106e56b",
      "status": "Completed",
      "createdAt": "2025-05-14T17:25:59.378Z",
      "completedAt": "2025-05-14T17:26:23.997Z",
      "percentComplete": 100
    },
    {
      "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
    }
  ],
  "pagination": undefined
}
Java
class RestoreJobList {
    data: [class RestoreJobModel {
        restoreJobId: cf597d76-4484-4b6c-b07c-2bfcac3388aa
        backupId: 0d75b99f-be61-4a93-905e-77201286c02e
        targetIndexName: restored-index
        targetIndexId: 8a810881-1505-46c0-b906-947c048b15f5
        status: Completed
        createdAt: 2025-05-16T20:09:18.700631Z
        completedAt: 2025-05-16T20:11:30.673296Z
        percentComplete: 100.0
        additionalProperties: null
    }, class RestoreJobModel {
        restoreJobId: 4902f735-b876-4e53-a05c-bc01d99251cb
        backupId: 8c85e612-ed1c-4f97-9f8c-8194e07bcf71
        targetIndexName: restored-index2
        targetIndexId: 710cb6e6-bfb4-4bf5-a425-9754e5bbc832
        status: Completed
        createdAt: 2025-05-15T21:06:19.906074Z
        completedAt: 2025-05-15T21:06:39.360509Z
        percentComplete: 100.0
        additionalProperties: null
    }]
    pagination: class PaginationResponse {
        next: eyJsaW1pdCI6Miwib2Zmc2V0IjoyfQ==
        additionalProperties: null
    }
    additionalProperties: null
}
Go
{
  "data": [
    {
      "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"
    },
    {
      "backup_id": "95707edb-e482-49cf-b5a5-312219a51a97",
      "completed_at": "2025-05-15T21:04:34.2463Z",
      "created_at": "2025-05-15T21:04:15.949067Z",
      "percent_complete": 100,
      "restore_job_id": "eee4f8b8-cd3e-45fe-9ed5-93c28e237f24",
      "status": "Completed",
      "target_index_id": "5a0d555f-7ccd-422a-a3a6-78f7b73350c0",
      "target_index_name": "restored-index2"
    }
  ],
  "pagination": {
    "next": "eyJsaW1pdCI6MTAsIm9mZnNldCI6MTB9"
  }
}
C#
{
  "data": [
    {
      "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
    },
    {
      "restore_job_id": "69acc1d0-9105-4fcb-b1db-ebf97b285c5e",
      "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "target_index_name": "restored-index2",
      "target_index_id": "e6c0387f-33db-4227-9e91-32181106e56b",
      "status": "Completed",
      "created_at": "2025-05-14T17:25:59.378989Z",
      "completed_at": "2025-05-14T17:26:23.997284Z",
      "percent_complete": 100
    }
  ]
}
curl
{
  "data": [
    {
      "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
    },
    {
      "restore_job_id": "69acc1d0-9105-4fcb-b1db-ebf97b285c5e",
      "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "target_index_name": "restored-index2",
      "target_index_id": "e6c0387f-33db-4227-9e91-32181106e56b",
      "status": "Completed",
      "created_at": "2025-05-14T17:25:59.378989Z",
      "completed_at": "2025-05-14T17:26:23.997284Z",
      "percent_complete": 100
    }
  ],
  "pagination": null
}

GET /restore-jobs

  • limit (query, integer) — The number of results to return per page.
  • paginationToken (query, string) — The token to use to retrieve the next page of results.
  • 200 — This operation returns a list of all the restore jobs that you have previously created.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 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