List backups for all indexes in a project

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

project_backups = pc.list_backups()

print(project_backups)

[{
    "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"
}]

GET

backups

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

project_backups = pc.list_backups()

print(project_backups)

[{
    "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"
}]

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

project_backups = pc.list_backups()

print(project_backups)

[{
    "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"
}]

Authorizations

Api-Key

string

header

required

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

Query Parameters

limit

integer

default:10

The number of results to return per page.

Required range: 1 <= x <= 100

paginationToken

string

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

Response

This operation returns a list of all the backups for the given index that you have previously created.

The list of backups that exist in the project.

data

object[]

Show child attributes

data.backup_id

string

required

Unique identifier for the backup.

Example:

"670e8400-e29b-41d4-a716-446655440001"

data.source_index_name

string

required

Name of the index from which the backup was taken.

Example:

"my-index"

data.source_index_id

string

required

ID of the index.

Example:

"670e8400-e29b-41d4-a716-446655440000"

data.status

string

required

Current status of the backup (e.g., Initializing, Ready, Failed).

Example:

"Ready"

data.cloud

string

required

Cloud provider where the backup is stored.

Example:

"aws"

data.region

string

required

Cloud region where the backup is stored.

Example:

"us-east-1"

data.name

string

Optional user-defined name for the backup.

Example:

"backup-2025-02-04"

data.description

string

Optional description providing context for the backup.

Example:

"Backup before bulk update."

data.dimension

integer<int32>

The dimensions of the vectors to be inserted in the index.

Required range: 1 <= x <= 20000

Example:

1536

data.metric

enum<string>

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.

Available options:

cosine,

euclidean,

dotproduct

data.record_count

integer

Total number of records in the backup.

Example:

120000

data.namespace_count

integer

Number of namespaces in the backup.

Example:

3

data.size_bytes

integer

Size of the backup in bytes.

Example:

10000000

data.tags

object

Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.

Show child attributes

data.tags.{key}

string

Example:

{ "tag0": "val0", "tag1": "val1" }

data.created_at

string

Timestamp when the backup was created.

pagination

object

The pagination object that is returned with paginated responses.

Show child attributes

pagination.next

string

required

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

Example:

"dXNlcl9pZD11c2VyXzE="

Example:

{ "next": "dXNlcl9pZD11c2VyXzE=" }

Create a backup of an index List backups for an index

⌘I

APIs

Database

Inference

Admin

SDKs

CLI

Tools

List backups for all indexes in a project

Authorizations

Query Parameters

Response