Create a backup of an index
Create a backup of an index.
Authorizations
Path Parameters
Name of the index to backup
Body
The configuration needed to create a backup of an index.
The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
1 - 45
"example-index"
A description of the backup.
Response
The BackupModel describes the configuration and status of a Pinecone backup.
Unique identifier for the backup.
"670e8400-e29b-41d4-a716-446655440001"
Name of the index from which the backup was taken.
"my-index"
ID of the index.
"670e8400-e29b-41d4-a716-446655440000"
Current status of the backup (e.g., Initializing, Ready, Failed).
"Ready"
Cloud provider where the backup is stored.
"aws"
Cloud region where the backup is stored.
"us-east-1"
Optional user-defined name for the backup.
"backup-2025-02-04"
Optional description providing context for the backup.
"Backup before bulk update."
The dimensions of the vectors to be inserted in the index.
1 <= x <= 20000
1536
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'.
cosine
, euclidean
, dotproduct
Total number of records in the backup.
120000
Number of namespaces in the backup.
3
Size of the backup in bytes.
10000000
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.
{ "tag0": "val0", "tag1": "val1" }
Timestamp when the backup was created.
Was this page helpful?