DEdefra
Cleanse Export

Start an ad-hoc full export of all active issues

Changed on

The export runs in a long-running background task with a distributed lock to prevent concurrent exports. Progress can be tracked via the returned export ID. Unlike the export phase of a cleanse analysis (which is incremental), this always exports all active issues. It does NOT update the incremental-export timestamp and does NOT send email notifications.

post/cleanse-export/start

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/cleanse-export/start
  • Auth
    API key in header X-API-Key

Response

Export started successfully

exportIdstring required

Unique identifier for the started export operation. Use this to poll progress.

statusstring required

Initial status of the export (Pending).

messagestring required
startedAtUtcstring date-time

Changes