v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
ExtractInfo

Begin tracking progress for an extract run

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.

get/ExtractInfo/start

Query parameters

archivestring required

Path to the backup archive being extracted. Must resolve within the current user's home directory.

directorystring required

Destination directory the archive is being extracted into. Must resolve within the current user's home directory.

Response

HTTP Request was successful.

apiversioninteger
funcstring
modulestring

Example response

{
  "apiversion": 3,
  "func": "start",
  "module": "ExtractInfo",
  "result": {
    "data": {
      "started": true
    },
    "status": 1
  }
}