Skip to main content
DELETE
Purge records

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id
string
required

ID of the record configuration whose records are purged

Query Parameters

space_id
string

Purge only records in this space

folder
string

Purge only records in this folder. Matched against the record's own folder, not parent_folder.

Response

Purge outcome. A 200 with a non-empty failed is a partial purge, not a failure.

status_code
integer

HTTP status code echoed in the response body.

body
object

scanned and purged are equal only on an unscoped purge, which deletes without reading. Failed records are left in place; a retry with the same scope picks them up.