Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Manage Indexes

Create a backup of an index

Create a backup of an index.

post/indexes/{index_name}/backups

Path parameters

index_namestring required

Name of the index to backup

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring

The name of the backup.

descriptionstring

A description of the backup.

Response

The backup has been successfully created.

backup_idstring required

Unique identifier for the backup.

source_index_namestring required

Name of the index from which the backup was taken.

source_index_idstring required

ID of the index.

namestring

Optional user-defined name for the backup.

descriptionstring

Optional description providing context for the backup.

statusstring required

Current status of the backup (e.g., Initializing, Ready, Failed).

cloudstring required

Cloud provider where the backup is stored.

regionstring required

Cloud region where the backup is stored.

dimensioninteger

The dimensions of the vectors to be inserted in the index.

metricstring

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'. Possible values: cosine, euclidean, or dotproduct.

record_countinteger

Total number of records in the backup.

namespace_countinteger

Number of namespaces in the backup.

size_bytesinteger

Size of the backup in bytes.

tagsIndexTags

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.

created_atstring

Timestamp when the backup was created.

Example response

{
  "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"
  }
}