Clear a partition

DELETE /1/indexes/:index/partitions/:partition

Requires a write or admin key. This is the one-call GDPR erasure path referenced in Partitions — call it when an account is deleted.

Response

{ "dataVersion": 483, "applied": 1, "ignoredAsStale": 0 }

applied here counts the clear as a single operation, regardless of how many records the partition held.

Example

curl -X DELETE https://api.usesuo.com/1/indexes/library/partitions/user_9f2 \
  -H "x-suo-key: suo_write_YOUR_KEY"

What this does

Every record and every tombstone belonging to :partition is removed immediately. Unlike an individual record delete, there is no 30-day tombstone retention here — this path exists specifically for the case where retaining even a tombstone is the wrong outcome (account deletion, a right-to-erasure request).

What this does not do

It does not touch the index's settings, other partitions, or non-partitioned records. An index with no partitionKey set has no partitions to clear; call this only on an index configured with one, as described in Partitions.

There is no undo

Once applied, the cleared data is not recoverable from the API. If you need a safety net, export what you need with a search before calling this — do not rely on point-in-time recovery as an undo path for a deliberate clear.