v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

ExtractInfo

Get progress for the current user's running archive extraction

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 2**32, 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.

get/ExtractInfo/progress

Response

HTTP Request was successful.

apiversioninteger

funcstring

modulestring

Example response

{
  "apiversion": 3,
  "func": "progress",
  "module": "ExtractInfo",
  "result": {
    "data": {
      "currentBytes": 104857600,
      "elapsedSeconds": 42,
      "percent": 33.3,
      "startedAtEpoch": 1750636800,
      "state": "inprogress",
      "totalBytes": 314572800
    },
    "status": 1
  }
}