# List backups for an index

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).

:::code-group
```bash 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"
```
:::

`GET /indexes/{index_name}/backups`

:::code-group
```json title="200"
{
  "data": [
    {
      "backup_id": "bkp_123abc",
      "cloud": "aws",
      "created_at": "2025-03-15T10:30:00.000Z",
      "description": "Monthly backup of production index",
      "name": "backup-2025-03-15",
      "namespace_count": 3,
      "record_count": 120000,
      "region": "us-east-1",
      "schema": {
        "fields": {
          "embedding": {
            "dimension": 1536,
            "metric": "cosine",
            "type": "dense_vector"
          }
        }
      },
      "size_bytes": 10000000,
      "source_index_id": "idx_456",
      "source_index_name": "my-index",
      "status": "Ready",
      "tags": {
        "environment": "production",
        "type": "monthly"
      }
    },
    {
      "backup_id": "bkp_789xyz",
      "cloud": "aws",
      "created_at": "2025-03-20T15:45:00.000Z",
      "description": "Pre-deployment safety backup",
      "name": "backup-2025-03-20",
      "namespace_count": 4,
      "record_count": 125000,
      "region": "us-east-1",
      "schema": {
        "fields": {
          "embedding": {
            "dimension": 1536,
            "metric": "cosine",
            "type": "dense_vector"
          }
        }
      },
      "size_bytes": 10500000,
      "source_index_id": "idx_456",
      "source_index_name": "my-index",
      "status": "Ready",
      "tags": {
        "environment": "production",
        "type": "pre-deploy"
      }
    }
  ],
  "pagination": {
    "next": "dXNlcl9pZD11c2VyXzE="
  }
}
```

```json title="400"
{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}
```

```json title="403"
{
  "error": {
    "code": "PERMISSION_DENIED",
    "message": "Access denied: Permission control::backups::list is required"
  },
  "status": 403
}
```

```json title="404"
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Index example-index not found."
  },
  "status": 404
}
```

```json title="500"
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
```
:::

#### Authorizations

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `Api-Key` | `string` | - |  |

An API Key is required to call Pinecone APIs. Get yours from the [console](https://app.pinecone.io/).

#### Headers

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `X-Pinecone-Api-Version` | `string` | `2026-07` | Required date-based version header |

#### Path Parameters

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `index_name` | `string` | - | 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. |

#### Query Parameters

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `include_deleted?` | `boolean` | `false` |  |

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.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `limit?` | `integer` | `100` | The number of results to return per page. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `paginationToken?` | `string` | - | The token to use to retrieve the next page of results. A malformed token is rejected with 400. |

#### Response

`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.

The list of backups that exist in the project.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `data?` | `object[]` | - | List of backup objects |

::::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `backup_id` | `string` | - | Unique identifier for the backup. Example: 670e8400-e29b-41d4-a716-446655440001 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `source_index_name` | `string` | - | Name of the index from which the backup was taken. Example: my-index |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `source_index_id` | `string` | - | ID of the index from which the backup was taken. Example: 670e8400-e29b-41d4-a716-446655440000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `source_index_deleted_at?` | `string` | - | The deletion timestamp when the source index has been deleted. Not present for backups associated with an active index. Example: 2024-03-05T12:00:00.000Z |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `name?` | `string` | - | Optional user-defined name for the backup. Example: backup-2025-02-04 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `description?` | `string` | - | Optional description providing context for the backup. Example: Backup before bulk update. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `status` | `string` | - | Current status of the backup. Example: Ready |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `cloud` | `string` | - | Cloud provider where the backup is stored. Example: aws |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `region` | `string` | - | Cloud region where the backup is stored. Example: us-east-1 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `schema?` | `object` | - | The schema of a Pinecone index. The schema defines the typed fields that documents in the index can contain, including vector fields, semantic text fields, and metadata fields. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `fields` | `object` | - | A map of field names to their configurations. Indexes that are served by the vectors API — created with the reserved _values / _sparse_values schema, or created by an earlier API version from dimension, metric, and vector_type — report their vector fields under the reserved names _values (dense) and _sparse_values (sparse), and any metadata fields configured for filtering as legacy fields carrying only filterable. Dense vectors-API indexes always report both _values and _sparse_values, regardless of how they were created. |
:::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `record_count?` | `integer` | - | Total number of records in the backup. Example: 120000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `namespace_count?` | `integer` | - | Number of namespaces in the backup. Example: 3 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `size_bytes?` | `integer` | - | Size of the backup in bytes. Example: 10000000 |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `tags?` | `object \| null` | - | Custom user tags added to an index, at most 20 per index. Keys must be 80 characters or less and alphanumeric, '', or '-'. Values must be 120 characters or less and consist of printable ASCII characters or spaces. To unset a key, set the value to be an empty string. null in responses when the index has no tags. |

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `created_at?` | `string` | - | Timestamp when the backup was created. Example: 2025-02-04T10:30:00.000Z |
::::

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `pagination?` | `object \| null` | - | Cursor envelope for the next page. null (or absent) on the final page of results. |

:::accordion{title="Show child attributes"}
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `next` | `string` | - | The token to use to retrieve the next page of results. Example: dXNlcl9pZD11c2VyXzE= |
:::

## Related pages

- [Create a backup of an index](./database-control-plane-create-backup.md)
- [List backups for all indexes in a project](./database-control-plane-list-project-backups.md)
- [Describe a backup](./database-control-plane-describe-backup.md)
- [Delete a backup](./database-control-plane-delete-backup.md)
- [Create an index from a backup](./database-control-plane-create-index-from-backup.md)
- [List restore jobs](./database-control-plane-list-restore-jobs.md)
- [Describe a restore job](./database-control-plane-describe-restore-job.md)
- [List collections](./database-control-plane-list-collections.md)
- [Create a collection](./database-control-plane-create-collection.md)
- [Describe a collection](./database-control-plane-describe-collection.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.