Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

List backups for an index

When include_deleted is false (or omitted), index_name must resolve to an active index in the project. If no active index by that name exists—including the case where only deleted indexes have used the name—the API returns 404, not an empty list.

When include_deleted is true, the API returns backups from every index in the project that has ever used this name (active and deleted). The source_index_deleted_at field is present only when the backup is from a deleted index. 404 is returned only when no index by that name has ever existed in the project (active or deleted).

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-04" \
    -H "accept: application/json"
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",
      "dimension":1024,
      "record_count":98,
      "namespace_count":3,
      "size_bytes":1069169,
      "created_at":"2025-03-11T18:29:50.549505Z"
      }
    ],
  "pagination":null
}

GET /indexes/{index_name}/backups

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • index_name (path, string, required) — Name of the index whose backups are listed. When include_deleted is false or omitted, this must resolve to an active index in the project.
  • include_deleted (query, boolean) — When true, includes backups for every index incarnation with this name (active and deleted). When false or omitted, only the active index’s backups are included; 404 when no active index has that name.
  • 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.
  • 200 — Returns backups associated with the index name. With include_deleted true, backups for all versions of the index name are returned. With include_deleted false, only backups for the active index are returned, or 404 if there is no active index.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Index not found.
  • 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