ExtractInfo

Start extract progress tracking

Changed on

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.
get/ExtractInfo/start

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

archivestring required
Example:/home/user/backups/backup-8.18.2026_12-53-12.tar.gz

The file path to the backup archive. It must resolve within the cPanel account's home directory.

directorystring required
Example:/home/user/restored/backup-8.18.2026_12-53-12

The destination directory where you want to extract the archive. It must resolve within the cPanel account's home directory.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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

Changes

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      added the new 0.00 enum value to the / response property for the response status

    • warning

      added the new 1.00 enum value to the / response property for the response status

    • info

      api operation id start removed and replaced with ExtractInfo-start

    • info

      added the optional property / to the response with the status