Create backup schedule

curl -sS -X POST "https://api.pinecone.io/indexes/${INDEX_NAME}/backup-schedules" \
  -H "api-key: ${PINECONE_API_KEY}" \
  -H "X-Pinecone-Api-Version: 2026-07" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-nightly-backup",
    "schedule": {
      "type": "time-based",
      "frequency": "daily"
    },
    "retention": {
      "expire_after_days": 7
    }
  }'

Create a recurring backup schedule for a serverless or BYOC index. Backups are created automatically based on the specified frequency and expired according to the retention policy. Each index supports one active schedule at a time.

• index_name (string, required) — The name of the index to create a backup schedule for.

• name (string, required) — A human-readable name for the backup schedule. Backups created by the schedule are automatically named {name}-{ISO8601_timestamp}.

• schedule (object, required) — The schedule configuration.

  Show schedule properties

  • type (string, required) — The type of schedule. Currently only time-based is supported.
  • frequency (string, required) — How often backups are created. One of daily, weekly, or monthly.

• retention (object, required) — The retention policy for backups created by this schedule.

  Show retention properties

  • expire_after_days (integer, required) — The number of days after which backups created by this schedule are automatically deleted.

curl -sS -X POST "https://api.pinecone.io/indexes/${INDEX_NAME}/backup-schedules" \
  -H "api-key: ${PINECONE_API_KEY}" \
  -H "X-Pinecone-Api-Version: 2026-07" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-nightly-backup",
    "schedule": {
      "type": "time-based",
      "frequency": "daily"
    },
    "retention": {
      "expire_after_days": 7
    }
  }'

Was this page helpful?