v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB

Manage Indexes

Create an index from a backup

Create an index from a backup.

post/backups/{backup_id}/create-index

Path parameters

backup_idstring required

The ID of the backup to create an index from.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

namestring required

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

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.

deletion_protectionstring

Whether deletion protection is enabled/disabled for the index. Possible values: disabled or enabled.

Example request

{
  "name": "example-index",
  "tags": {
    "tag0": "val0",
    "tag1": "val1"
  }
}

Response

The request to create the index has been accepted.

restore_job_idstring required

The ID of the restore job that was created.

index_idstring required

The ID of the index that was created from the backup.

Example response

{
  "restore_job_id": "670e8400-e29b-41d4-a716-446655440000",
  "index_id": "123e4567-e89b-12d3-a456-426614174000"
}