v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

BackupInfo

Get progress for the current user's running full-account backup

Returns telemetry for a full-account backup. When the PkgAcct::Create hook is installed it anchors the run's start and finish; 'complete' is reported only once the published archive is confirmed in the homedir (returning its exact final size), so a run that never publishes an archive is never reported complete. Otherwise it falls back to the on-disk marker. While running, estimatedPercent is an ESTIMATE (the final archive is gzipped, so the byte total is multiplied by a heuristic compression factor) clamped to 99. Degrades to zeros when nothing is running or when quota data is unavailable. Read-only and safe to poll.

get/BackupInfo/progress

Response

HTTP Request was successful.

apiversioninteger

funcstring

modulestring

Example response

{
  "apiversion": 3,
  "func": "progress",
  "module": "BackupInfo",
  "result": {
    "data": {
      "state": "inprogress",
      "stateSource": "hook",
      "startedAtEpoch": 1750636800,
      "finishedAtEpoch": 1750640400,
      "elapsedSeconds": 42,
      "currentBytes": 104857600,
      "estimatedTotalBytes": 314572800,
      "estimatedPercent": 33.3
    },
    "status": 1
  }
}