v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Manage Indexes

List backups for all indexes in a project

List all backups for a project.

get/backups

Query parameters

limitinteger

The number of results to return per page.

paginationTokenstring

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

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

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

Example response

{
  "data": [
    {
      "backup_id": "670e8400-e29b-41d4-a716-446655440001",
      "source_index_name": "my-index",
      "source_index_id": "670e8400-e29b-41d4-a716-446655440000",
      "name": "backup-2025-02-04",
      "description": "Backup before bulk update.",
      "status": "Ready",
      "cloud": "aws",
      "region": "us-east-1",
      "dimension": 1536,
      "schema": {
        "fields": {
          "description": {
            "filterable": true
          },
          "genre": {
            "filterable": true
          },
          "year": {
            "filterable": true
          }
        }
      },
      "record_count": 120000,
      "namespace_count": 3,
      "size_bytes": 10000000,
      "tags": {
        "tag0": "val0",
        "tag1": "val1"
      }
    }
  ],
  "pagination": {
    "next": "dXNlcl9pZD11c2VyXzE="
  }
}