POST /indexes/{index_name}/backups

Create a backup of an index.

Servers

Path parameters

Name Type Required Description
index_name String Yes

Name of the index to backup

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

X-Pinecone-Api-Version String Yes

Required date-based version header

Default value: "2025-10"

Request body fields

Name Type Required Description
name String No

The name of the backup.

description String No

A description of the backup.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.