Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List restore jobs

List all restore jobs for a project.

curl
PINECONE_API_KEY="YOUR_API_KEY"

curl "https://api.pinecone.io/restore-jobs" \
	-H "X-Pinecone-Api-Version: 2026-07" \
	-H "Api-Key: $PINECONE_API_KEY"

GET /restore-jobs

200
{
  "data": [
    {
      "backup_id": "670e8400-e29b-41d4-a716-446655440000",
      "completed_at": "2024-03-15T10:35:00.000Z",
      "created_at": "2024-03-15T10:30:00.000Z",
      "percent_complete": 100,
      "restore_job_id": "670e8400-e29b-41d4-a716-446655440001",
      "status": "Completed",
      "target_index_id": "idx_456",
      "target_index_name": "my-index"
    }
  ],
  "pagination": {
    "next": "dXNlcl9pZD11c2VyXzE="
  }
}
400
{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}
403
{
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Access denied: Permission control::backups::list is required"
  },
  "status": 403
}
500
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
Api-Keystringrequired

An API Key is required to call Pinecone APIs. Get yours from the console.

X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-07
limit?integer

The number of results to return per page.

Typeinteger
Default100
paginationToken?string

The token to use to retrieve the next page of results. A malformed token is rejected with 400.

Typestring

200 — This operation returns a list of all the restore jobs that you have previously created.

The list of restore jobs that exist in the project.

dataobject[]required

List of restore job objects

Typeobject[]
Show child attributes
restore_job_idstringrequired

Unique identifier for the restore job

Example: 670e8400-e29b-41d4-a716-446655440001

Typestring
backup_idstringrequired

Backup used for the restore

Example: 670e8400-e29b-41d4-a716-446655440000

Typestring
target_index_namestringrequired

Name of the index into which data is being restored

Example: sample-index

Typestring
target_index_idstringrequired

ID of the index

Example: 670e8400-e29b-41d4-a716-446655440002

Typestring
statusstringrequired

Status of the restore job. Possible values: Pending, Completed, Failed, or Cancelled.

Example: Completed

Typestring
created_atstring | nullrequired

Timestamp when the restore job started

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

Typestring | null
completed_at?string | null

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

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

Typestring | null
percent_complete?integer

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

Typeinteger
pagination?object | null

Cursor envelope for the next page. null (or absent) on the final page of results.

Typeobject | null
Show child attributes
nextstringrequired

The token to use to retrieve the next page of results.

Example: dXNlcl9pZD11c2VyXzE=

Typestring
Suggest an edit

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

Export
Documentation menu