Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

List backups for all indexes in a project

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

project_backups = pc.list_backups()

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

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

const projectBackups = await pc.listBackups();

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

public class CreateBackup {
    public static void main(String[] args) throws ApiException {
        Pinecone pc = new Pinecone.Builder("YOUR_API_KEY").build();

        String indexName = "docs-example";
        BackupList projectBackupList = pc.listProjectBackups();

        System.out.println(projectBackupList);
    }
}
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 := 3
	backups, err := pc.ListBackups(ctx, &pinecone.ListBackupsParams{
		Limit:     &limit,
	})
	if err != nil {
		log.Fatalf("Failed to list backups: %v", err)
	}
	fmt.Printf(prettifyStruct(backups))
}
C#
using Pinecone;

var pinecone = new PineconeClient("PINECONE_API_KEY");

var backups = await pinecone.Backups.ListAsync();

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

curl -X GET "https://api.pinecone.io/backups" \
     -H "Api-Key: $PINECONE_API_KEY" \
     -H "X-Pinecone-Api-Version: 2025-04" \
     -H "accept: application/json"
Python
[{
    "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
    "source_index_name": "docs-example",
    "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
    "status": "Ready",
    "cloud": "aws",
    "region": "us-east-1",
    "tags": {},
    "name": "example-backup",
    "description": "Monthly backup of production index",
    "dimension": 1024,
    "record_count": 98,
    "namespace_count": 3,
    "size_bytes": 1069169,
    "created_at": "2025-05-15T20:26:21.248515Z"
}, {
    "backup_id": "95707edb-e482-49cf-b5a5-312219a51a97",
    "source_index_name": "docs-example2",
    "source_index_id": "b49f27d1-1bf3-49c6-82b5-4ae46f00f0e6",
    "status": "Ready",
    "cloud": "aws",
    "region": "us-east-1",
    "tags": {},
    "name": "example-backup2",
    "description": "Monthly backup of production index",
    "dimension": 1024,
    "record_count": 97,
    "namespace_count": 2,
    "size_bytes": 1069169,
    "created_at": "2025-05-15T00:52:10.809354Z"
}, {
    "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
    "source_index_name": "docs-example3",
    "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
    "status": "Ready",
    "cloud": "aws",
    "region": "us-east-1",
    "tags": {},
    "name": "example-backup3",
    "description": "Monthly backup of production index",
    "dimension": 1024,
    "record_count": 98,
    "namespace_count": 3,
    "size_bytes": 1069169,
    "created_at": "2025-05-14T16:37:25.625540Z"
}]
JavaScript
{
  "data": [
    {
      "backupId": "e12269b0-a29b-4af0-9729-c7771dec03e3",
      "sourceIndexName": "docs-example",
      "sourceIndexId": "bcb5b3c9-903e-4cb6-8b37-a6072aeb874f",
      "name": "example-backup",
      "description": undefined,
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 0,
      "metric": undefined,
      "recordCount": 96,
      "namespaceCount": 1,
      "sizeBytes": 86393,
      "tags": undefined,
      "createdAt": "2025-05-14T17:00:45.803146Z"
    },
    {
      "backupId": "d686451d-1ede-4004-9f72-7d22cc799b6e",
      "sourceIndexName": "docs-example2",
      "sourceIndexId": "b49f27d1-1bf3-49c6-82b5-4ae46f00f0e6",
      "name": "example-backup2",
      "description": undefined,
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "metric": undefined,
      "recordCount": 50,
      "namespaceCount": 1,
      "sizeBytes": 545171,
      "tags": undefined,
      "createdAt": "2025-05-14T17:00:34.814371Z"
    },
    {
      "backupId": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "sourceIndexName": "docs-example3",
      "sourceIndexId": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
      "name": "example-backup3",
      "description": "Monthly backup of production index",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "metric": undefined,
      "recordCount": 98,
      "namespaceCount": 3,
      "sizeBytes": 1069169,
      "tags": {},
      "createdAt": "2025-05-14T16:37:25.625540Z"
    }
  ],
  "pagination": undefined
}
Java
class BackupList {
    data: [class BackupModel {
        backupId: 13761d20-7a0b-4778-ac27-36dd91c4be43
        sourceIndexName: example-dense-index
        sourceIndexId: f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74
        name: example-backup-java2
        description: Monthly backup of production index
        status: Initializing
        cloud: aws
        region: us-east-1
        dimension: null
        metric: null
        recordCount: null
        namespaceCount: null
        sizeBytes: null
        tags: {}
        createdAt: 2025-05-16T19:46:26.248428Z
        additionalProperties: null
    }, class BackupModel {
        backupId: 0d75b99f-be61-4a93-905e-77201286c02e
        sourceIndexName: example-dense-index
        sourceIndexId: f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74
        name: example-backup-java
        description: Monthly backup of production index
        status: Initializing
        cloud: aws
        region: us-east-1
        dimension: null
        metric: null
        recordCount: null
        namespaceCount: null
        sizeBytes: null
        tags: {}
        createdAt: 2025-05-16T19:42:23.804820Z
        additionalProperties: null
    }, class BackupModel {
        backupId: bf2cda5d-b233-4a0a-aae9-b592780ad3ff
        sourceIndexName: example-sparse-index
        sourceIndexId: bcb5b3c9-903e-4cb6-8b37-a6072aeb874f
        name: example-sparse-python
        description: Monthly backup of production index
        status: Ready
        cloud: aws
        region: us-east-1
        dimension: 0
        metric: null
        recordCount: 96
        namespaceCount: 1
        sizeBytes: 86393
        tags: {}
        createdAt: 2025-05-16T18:01:51.531129Z
        additionalProperties: null
    }]
    pagination: null
    additionalProperties: null
}
Go
{
  "data": [
    {
      "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "cloud": "aws",
      "created_at": "2025-05-15T00:52:10.809305882Z",
      "description": "Monthly backup of production index",
      "dimension": 1024,
      "name": "example-backup",
      "namespace_count": 3,
      "record_count": 98,
      "region": "us-east-1",
      "size_bytes": 1069169,
      "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
      "source_index_name": "docs-example",
      "status": "Ready",
      "tags": {}
    },
    {
      "backup_id": "bf2cda5d-b233-4a0a-aae9-b592780ad3ff",
      "cloud": "aws",
      "created_at": "2025-05-15T00:52:10.809305882Z",
      "description": "Monthly backup of production index",
      "dimension": 0,
      "name": "example-backup2",
      "namespace_count": 1,
      "record_count": 96,
      "region": "us-east-1",
      "size_bytes": 86393,
      "source_index_id": "bcb5b3c9-903e-4cb6-8b37-a6072aeb874f",
      "source_index_name": "example-sparse-index",
      "status": "Ready",
      "tags": {}
    },
    {
      "backup_id": "f73028f6-1746-410e-ab6d-9dd2519df4de",
      "cloud": "aws",
      "created_at": "2025-05-15T20:26:21.248515Z",
      "description": "Monthly backup of production index",
      "dimension": 1024,
      "name": "example-backup3",
      "namespace_count": 2,
      "record_count": 97,
      "region": "us-east-1",
      "size_bytes": 1069169,
      "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
      "source_index_name": "example-dense-index",
      "status": "Ready",
      "tags": {}
    }
  ],
  "pagination": {
    "next": "eyJsaW1pdCI6Miwib2Zmc2V0IjoyfQ=="
  }  
}
C#
{
  "data": [
    {
      "backup_id": "95707edb-e482-49cf-b5a5-312219a51a97",
      "source_index_name": "docs-example",
      "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
      "name": "example-backup",
      "description": "Monthly backup of production index",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "record_count": 97,
      "namespace_count": 2,
      "size_bytes": 1069169,
      "tags": {},
      "created_at": "2025-05-15T00:52:10.809354Z"
    },
    {
      "backup_id": "e12269b0-a29b-4af0-9729-c7771dec03e3",
      "source_index_name": "docs-example2",
      "source_index_id": "bcb5b3c9-903e-4cb6-8b37-a6072aeb874f",
      "name": "example-backup2",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 0,
      "record_count": 96,
      "namespace_count": 1,
      "size_bytes": 86393,
      "created_at": "2025-05-14T17:00:45.803146Z"
    },
    {
      "backup_id": "d686451d-1ede-4004-9f72-7d22cc799b6e",
      "source_index_name": "docs-example3",
      "source_index_id": "b49f27d1-1bf3-49c6-82b5-4ae46f00f0e6",
      "name": "example-backup3",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "record_count": 50,
      "namespace_count": 1,
      "size_bytes": 545171,
      "created_at": "2025-05-14T17:00:34.814371Z"
    }
  ]
}
curl
{
  "data": [
    {
      "backup_id": "e12269b0-a29b-4af0-9729-c7771dec03e3",
      "source_index_id": "bcb5b3c9-903e-4cb6-8b37-a6072aeb874f",
      "source_index_name": "docs-example",
      "tags": null,
      "name": "example-backup",
      "description": null,
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 0,
      "record_count": 96,
      "namespace_count": 1,
      "size_bytes": 86393,
      "created_at": "2025-05-14T17:00:45.803146Z"
    },
    {
      "backup_id": "d686451d-1ede-4004-9f72-7d22cc799b6e",
      "source_index_id": "b49f27d1-1bf3-49c6-82b5-4ae46f00f0e6",
      "source_index_name": "docs-example2",
      "tags": null,
      "name": "example-backup2",
      "description": null,
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "record_count": 50,
      "namespace_count": 1,
      "size_bytes": 545171,
      "created_at": "2025-05-14T17:00:34.814371Z"
    },
    {
      "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
      "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
      "source_index_name": "docs-example3",
      "tags": {},
      "name": "example-backup3",
      "description": "Monthly backup of production index",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1024,
      "record_count": 98,
      "namespace_count": 3,
      "size_bytes": 1069169,
      "created_at": "2025-05-14T16:37:25.625540Z"
    }
  ],
  "pagination": null
}

GET /backups

Parameters

Section titled “Parameters”
  • 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.

Responses

Section titled “Responses”
  • 200 — This operation returns a list of all the backups for the given index 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