Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Back up an index

Create backups of serverless indexes to protect data, copy indexes, or experiment with configurations using the Pinecone SDK, API, or console.

Create a backup

Section titled “Create a backup”

You can create a backup from a serverless index as follows.

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

backup = pc.create_backup(
    index_name="docs-example", 
    backup_name="example-backup", 
    description="Monthly backup of production index"
)

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

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

const backup = await pc.createBackup({
  indexName: 'docs-example',
  name: 'example-backup',
  description: 'Monthly backup of production index',
});

console.log(backup);
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";
        String backupName = "example-backup";
        String backupDescription = "Monthly backup of production index";

        BackupModel backup = pc.createBackup(indexName,backupName, backupDescription);

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

    indexName := "docs-example"
    backupName := "example-backup"
    backupDesc := "Monthly backup of production index"

    backup, err := pc.CreateBackup(ctx, &pinecone.CreateBackupParams{
        IndexName:   indexName,
        Name:        &backupName,
        Description: &backupDesc,
    })
    if err != nil {
        log.Fatalf("Failed to create backup: %v", err)
    }

    fmt.Printf(prettifyStruct(backup))
}
curl
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="docs-example"

curl "https://api.pinecone.io/indexes/$INDEX_NAME/backups" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H "X-Pinecone-Api-Version: 2026-07" \
    -d '{
      "name": "example-backup", 
      "description": "Monthly backup of production index"
      }'

The example returns a response like the following:

Python
{'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': {}}
JavaScript
{
  backupId: '8c85e612-ed1c-4f97-9f8c-8194e07bcf71',
  sourceIndexName: 'docs-example',
  sourceIndexId: 'f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74',
  name: 'example-backup',
  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'
}
Java
class BackupModel {
    backupId: 0d75b99f-be61-4a93-905e-77201286c02e
    sourceIndexName: docs-example
    sourceIndexId: f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74
    name: example-backup
    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.804787550Z
    additionalProperties: null
}
Go
{
  "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",
  "region": "us-east-1",
  "source_index_id": "f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
  "source_index_name": "docs-example",
  "status": "Initializing",
  "tags": {}
}
curl
{
  "backup_id":"8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "source_index_id":"f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Ready",
  "cloud":"aws",
  "region":"us-east-1",
  "schema":{
    "fields":{
      "embedding":{
        "type":"dense_vector",
        "description":null,
        "dimension":1024,
        "metric":"cosine"
      }
    }
  },
  "record_count":96,
  "namespace_count":3,
  "size_bytes":1069169,
  "created_at":"2025-05-14T16:37:25.625540Z"
  }

Describe a backup

Section titled “Describe a backup”

You can view the details of a backup as follows.

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

backup = pc.describe_backup(backup_id="8c85e612-ed1c-4f97-9f8c-8194e07bcf71")

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

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

const backupDesc = await pc.describeBackup('8c85e612-ed1c-4f97-9f8c-8194e07bcf71');

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

        BackupModel backupModel = pc.describeBackup("8c85e612-ed1c-4f97-9f8c-8194e07bcf71");

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

	backup, err := pc.DescribeBackup(ctx, "8c85e612-ed1c-4f97-9f8c-8194e07bcf71")
	if err != nil {
		log.Fatalf("Failed to describe backup: %v", err)
	}
	fmt.Printf(prettifyStruct(backup))
}
curl
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="8c85e612-ed1c-4f97-9f8c-8194e07bcf71"

curl -X GET "https://api.pinecone.io/backups/$BACKUP_ID" \
    -H "Api-Key: $PINECONE_API_KEY" \
    -H "X-Pinecone-Api-Version: 2026-07" \
    -H "accept: application/json"

The example returns a response like the following:

Python
{'backup_id': '8c85e612-ed1c-4f97-9f8c-8194e07bcf71',
 'cloud': 'aws',
 'created_at': '2025-05-15T00:52:10.809354Z',
 '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': {}}
JavaScript
{
  backupId: '8c85e612-ed1c-4f97-9f8c-8194e07bcf71',
  sourceIndexName: 'docs-example',
  sourceIndexId: 'f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74',
  name: 'example-backup',
  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'
}
Java
class BackupList {
    data: [class BackupModel {
        backupId: 95707edb-e482-49cf-b5a5-312219a51a97
        sourceIndexName: docs-example
        sourceIndexId: f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74
        name: example-backup
        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
    }]
    pagination: null
    additionalProperties: null
}
Go
{
  "backup_id": "8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "cloud": "aws",
  "created_at": "2025-05-15T00:52:10.809354Z",
  "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": {}
}
curl
{
  "backup_id":"8c85e612-ed1c-4f97-9f8c-8194e07bcf71",
  "source_index_id":"f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74",
  "source_index_name":"docs-example",
  "tags":{},
  "name":"example-backup",
  "description":"Monthly backup of production index",
  "status":"Ready",
  "cloud":"aws",
  "region":"us-east-1",
  "schema":{
    "fields":{
      "embedding":{
        "type":"dense_vector",
        "description":null,
        "dimension":1024,
        "metric":"cosine"
      }
    }
  },
  "record_count":98,
  "namespace_count":3,
  "size_bytes":1069169,
  "created_at":"2025-03-11T18:29:50.549505Z"
}

List backups for an index

Section titled “List backups for an index”

You can list backups for a specific index as follows.

Up to 100 backups are returned at a time by default, in sorted order (bitwise “C” collation). If the limit parameter is set, up to that number of backups are returned instead. Whenever there are additional backups to return, the response also includes a pagination_token that you can use to get the next batch of backups. When the response doesn't include a pagination_token, there are no more backups to return.

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index_backups = pc.list_backups(index_name="docs-example")

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

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

const indexBackups = await pc.listBackups({ indexName: 'docs-example' });

console.log(indexBackups);
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 indexBackupList = pc.listIndexBackups(indexName);

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

	indexName := "docs-example"
	limit := 2
	indexBackups, err := pc.ListBackups(ctx, &pinecone.ListBackupsParams{
		Limit: &limit,
		IndexName: &indexName,
	})
	if err != nil {
		log.Fatalf("Failed to list backups: %v", err)
	}
	fmt.Printf(prettifyStruct(indexBackups))
}
curl
PINECONE_API_KEY="YOUR_API_KEY"
INDEX_NAME="docs-example"

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

The example returns a response like the following:

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-15T00:52:10.809305882Z"
}]
JavaScript
{
  data: [
    {
      backupId: '8c85e612-ed1c-4f97-9f8c-8194e07bcf71',
      sourceIndexName: 'docs-example',
      sourceIndexId: 'f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74',
      name: 'example-backup',
      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: 8c85e612-ed1c-4f97-9f8c-8194e07bcf71
        sourceIndexName: docs-example
        sourceIndexId: f73b36c9-faf5-4a2c-b1d6-4013d8b1cc74
        name: example-backup
        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
    }]
    pagination: null
    additionalProperties: null
}
Go
{
  "data": [
    {
      "backup_id": "bf2cda5d-b233-4a0a-aae9-b592780ad3ff",
      "cloud": "aws",
      "created_at": "2025-05-16T18:01:51.531129Z",
      "description": "Monthly backup of production index",
      "dimension": 0,
      "name": "example-backup",
      "namespace_count": 1,
      "record_count": 96,
      "region": "us-east-1",
      "size_bytes": 86393,
      "source_index_id": "bcb5b3c9-903e-4cb6-8b37-a6072aeb874f",
      "source_index_name": "docs-example",
      "status": "Ready",
      "tags": {}
    },
    {
      "backup_id": "e12269b0-a29b-4af0-9729-c7771dec03e3",
      "cloud": "aws",
      "created_at": "2025-05-14T17:00:45.803146Z",
      "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": "docs-example",
      "status": "Ready"
    }
  ],
  "pagination": {
    "next": "eyJsaW1pdCI6Miwib2Zmc2V0IjoyfQ=="
  }
}
curl
{
  "data":
  [
    {
      "backup_id":"9947520e-d5a1-4418-a78d-9f464c9969da",
      "source_index_id":"8433941a-dae7-43b5-ac2c-d3dab4a56b2b",
      "source_index_name":"docs-example",
      "tags":{},
      "name":"example-backup",
      "description":"Monthly backup of production index",
      "status":"Pending",
      "cloud":"aws",
      "region":"us-east-1",
      "schema":{
        "fields":{
          "embedding":{
            "type":"dense_vector",
            "description":null,
            "dimension":1024,
            "metric":"cosine"
          }
        }
      },
      "record_count":98,
      "namespace_count":3,
      "size_bytes":1069169,
      "created_at":"2025-03-11T18:29:50.549505Z"
      }
    ],
  "pagination":null
}

List backups in a project

Section titled “List backups in a project”

You can list backups for all indexes in a project as follows.

Up to 100 backups are returned at a time by default, in sorted order (bitwise “C” collation). If the limit parameter is set, up to that number of backups are returned instead. Whenever there are additional backups to return, the response also includes a pagination_token that you can use to get the next batch of backups. When the response doesn't include a pagination_token, there are no more backups to return.

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))
}
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: 2026-07" \
    -H "accept: application/json"

The example returns a response like the following:

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
        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-backup2
        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-backup3
        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=="
  }  
}
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",
      "schema": {
        "fields": {
          "sparse_embedding": {
            "type": "sparse_vector",
            "description": null
          }
        }
      },
      "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",
      "schema": {
        "fields": {
          "embedding": {
            "type": "dense_vector",
            "description": null,
            "dimension": 1024,
            "metric": "cosine"
          }
        }
      },
      "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",
      "schema": {
        "fields": {
          "embedding": {
            "type": "dense_vector",
            "description": null,
            "dimension": 1024,
            "metric": "cosine"
          }
        }
      },
      "record_count": 98,
      "namespace_count": 3,
      "size_bytes": 1069169,
      "created_at": "2025-05-14T16:37:25.625540Z"
    }
  ],
  "pagination": null
}

Delete a backup

Section titled “Delete a backup”

You can delete a backup as follows.

Python
from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

pc.delete_backup(backup_id="9947520e-d5a1-4418-a78d-9f464c9969da")
JavaScript
import { Pinecone } from '@pinecone-database/pinecone';

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

await pc.deleteBackup('9947520e-d5a1-4418-a78d-9f464c9969da');
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();

        pc.deleteBackup("9947520e-d5a1-4418-a78d-9f464c9969da");
    }
}
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)
	}

	err = pc.DeleteBackup(ctx, "8c85e612-ed1c-4f97-9f8c-8194e07bcf71")
	if err != nil {
		log.Fatalf("Failed to delete backup: %v", err)
	} else {
		fmt.Println("Backup deleted successfully")
	}
}
curl
PINECONE_API_KEY="YOUR_API_KEY"
BACKUP_ID="9947520e-d5a1-4418-a78d-9f464c9969da"

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

Schedule automated backups

Section titled “Schedule automated backups”

Instead of creating backups manually, you can define a recurring schedule that automatically creates backups at a daily, weekly, or monthly frequency. Each schedule includes a retention policy that automatically deletes old backups, keeping storage costs predictable. Each index supports one active schedule at a time.

Create a backup schedule

Section titled “Create a backup schedule”
  1. Open the Pinecone console and go to the Backups tab.
  2. Find your index and, in the Schedule column, click add. Alternatively, select Schedule backups from the actions menu of the index.
  3. In the Add a backup schedule modal, select a Frequency (daily, weekly, or monthly).
  4. Select a Retention period. Each backup created by the schedule is automatically deleted after this period.
  5. Click Add schedule.

Pinecone names the schedule and assigns its run time automatically.

To create a backup schedule:

curl
curl -sS -X POST "https://api.pinecone.io/indexes/${INDEX_NAME}/backup-schedules" \
  -H "api-key: ${PINECONE_API_KEY}" \
  -H "X-Pinecone-Api-Version: 2026-07" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-nightly-backup",
    "schedule": {
      "type": "time-based",
      "frequency": "daily"
    },
    "retention": {
      "expire_after_days": 7
    }
  }'

Use "frequency": "weekly" or "monthly" as needed. The retention policy (expire_after_days) is required.

Manage backup schedules

Section titled “Manage backup schedules”
  1. Open the Pinecone console and go to the Backups tab.
  2. Find your index and, in the Schedule column, click the schedule. This opens the Scheduled backups page for the index.

For each schedule, the page shows the frequency, retention period, and next scheduled run time. From here, you can:

  • Pause or resume a schedule: Use the toggle on the schedule. An index can have up to three schedules, but only one can be enabled at a time.
  • Edit a schedule: Expand the schedule, change the Frequency or Retention, and click Update.
  • Delete a schedule: Select Delete from the actions menu of the schedule.

You can list schedules, update a schedule (e.g., to pause it or change the frequency), delete a schedule, and view the backup history for a schedule.

Deleting a schedule doesn't delete any backups that were previously created by it. For more details, see Scheduled backups.

Suggest an edit

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

Export
Documentation menu