Skip to main content
DELETE https://api.poixe.com/v1/recoveries?all=true
Deletes all stored records for the current user. This is a destructive operation, and you must explicitly include all=true as a confirmation parameter (to prevent accidental deletion). You can also run a preview first with dry_run=true: it returns only the number of records expected to be deleted and does not actually delete anything.

Authentication and request headers

Every API request must include your API key in the HTTP headers.
string
required
Bearer token. The format is Bearer YOUR_API_KEY.
string
required
Must be set to application/json.

Query parameters

string
required
Must be true. Confirms that you want to “delete all”.
string
Optional: when true, only previews and does not delete; the response returns would_delete.

Response structure

integer
The number of records actually deleted (usually 0 for a dry_run).
integer
Returned only for a dry_run: the number of records that would be deleted.
string
Result description.
string
Result reason (such as OK / DRY_RUN / CONFIRMATION_REQUIRED).
We recommend first calling DELETE /v1/recoveries?all=true&dry_run=true to confirm the count, and then performing the actual deletion: DELETE /v1/recoveries?all=true.