# ExtractInfo

The ExtractInfo module for UAPI.

## Clear the current user's extract run-state marker

 - [GET /ExtractInfo/finish](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/finish.md): Clears the run-state marker written by ExtractInfo.start. After finish, progress reports state 'none'. Idempotent - succeeds whether or not a marker exists. Call after Fileman.fileop op=extract completes (success or failure).

## Get progress for the current user's running archive extraction

 - [GET /ExtractInfo/progress](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/progress.md): Returns telemetry for an in-progress archive extraction started via ExtractInfo.start. currentBytes is how much the destination directory has grown since the start baseline; totalBytes is the uncompressed archive size recorded at start, exact for archives under 4 GiB and a best-effort estimate for larger ones (the gzip trailer stores the uncompressed size modulo 232, so it wraps at 4 GiB). totalBytesEstimated reports which of those two cases applies. percent is derived from currentBytes and totalBytes and clamped to 99; it is approximate whenever totalBytesEstimated is true. Degrades to zeros when no run is active. Read-only and safe to poll.

## Begin tracking progress for an extract run

 - [GET /ExtractInfo/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/start.md): Begins tracking an extract run for the given archive and destination directory (both must resolve within the current user's home directory). Computes the exact uncompressed byte size of the archive and snapshots the destination directory's current disk usage as a baseline, then writes a run-state marker. Returns immediately; no extraction happens in this function. Call before Fileman.fileop op=extract.