List backups for an index

GET

indexes

{index_name}

backups

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="example-index"

curl -X GET "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-API-Version: 2025-04" \
    -H "accept: application/json"

{
  "data":
  [
    {
      "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
      "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
      "source_index_name":"example-index",
      "tags":{},
      "name":"example-backup",
      "description":"Monthly backup of production index",
      "status":"Pending",
      "cloud":"aws",
      "region":"us-east-1",
      "dimension":null,
      "record_count":null,
      "namespace_count":null,
      "size_bytes":null,
      "created_at":"2025-03-11T18:29:50.549505Z"
      }
    ],
  "pagination":null
}

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="example-index"

curl -X GET "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-API-Version: 2025-04" \
    -H "accept: application/json"

{
  "data":
  [
    {
      "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
      "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
      "source_index_name":"example-index",
      "tags":{},
      "name":"example-backup",
      "description":"Monthly backup of production index",
      "status":"Pending",
      "cloud":"aws",
      "region":"us-east-1",
      "dimension":null,
      "record_count":null,
      "namespace_count":null,
      "size_bytes":null,
      "created_at":"2025-03-11T18:29:50.549505Z"
      }
    ],
  "pagination":null
}

Authorizations

Api-Key

string

header

required

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

Path Parameters

index_name

string

required

Name of the backed up index

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

200

application/json

This operation returns a list of all the backups that you have previously created, and which are associated with the given index.

The list of backups that exist in the project.

data

object[]

The BackupModel describes the configuration and status of a Pinecone backup.

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

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.

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.

Example:

{ "next": "dXNlcl9pZD11c2VyXzE=" }

Was this page helpful?

List backups for all indexes in a project Describe a backup

PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="example-index"

curl -X GET "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-API-Version: 2025-04" \
    -H "accept: application/json"

{
  "data":
  [
    {
      "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
      "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
      "source_index_name":"example-index",
      "tags":{},
      "name":"example-backup",
      "description":"Monthly backup of production index",
      "status":"Pending",
      "cloud":"aws",
      "region":"us-east-1",
      "dimension":null,
      "record_count":null,
      "namespace_count":null,
      "size_bytes":null,
      "created_at":"2025-03-11T18:29:50.549505Z"
      }
    ],
  "pagination":null
}

APIs

Database

Inference

Admin

SDKs

Architecture

Tools

List backups for an index

Authorizations

Path Parameters

Query Parameters

Response