# ExtractInfo

The ExtractInfo module for UAPI.

## Remove extract progress record

 - [GET /ExtractInfo/finish](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/extractinfo-finish.md): This function clears the run-state marker that the ExtractInfo::start
function wrote.

Note:
After it runs, the ExtractInfo::progress function reports the state
none. This function is idempotent and succeeds whether or not a marker
exists. Call it after the Fileman::fileop function with op=extract
finishes, whether that operation succeeded or failed.

## Return archive extraction progress

 - [GET /ExtractInfo/progress](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/extractinfo-progress.md): This function returns progress information for an archive extraction
that the ExtractInfo::start function began.

Note:
When no run is active, the state return value is none and the other
return values are 0 or null.

## Start extract progress tracking

 - [GET /ExtractInfo/start](https://api.docs.cpanel.net/specifications/cpanel.openapi/extractinfo/extractinfo-start.md): This function starts progress tracking for a File Manager extract
operation.

Note:

* The Fileman::fileop function with op=extract is a single
  synchronous call to tar that reports no progress of its own. This
  function brackets that call from the outside so that a caller can show
  real progress.
* Call this function first, then call the Fileman::fileop function to
  perform the extract, poll the ExtractInfo::progress function while
  it runs, and call the ExtractInfo::finish function when it
  completes.
* The function records the archive's total uncompressed byte size and a
  baseline snapshot of the destination directory's disk usage, then
  writes a run-state marker.
* This function returns immediately and extracts nothing itself.