v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

BackupInfo

List the current user's full-account backups

Scans the current cPanel user's home directory for full-account backup archives and returns one entry per archive, deriving real status from the on-disk marker file cPanel writes during a run. Single source of truth for the available-backups table. Read-only.

get/BackupInfo/list

Response

HTTP Request was successful.

apiversioninteger

funcstring

modulestring

Example response

{
  "apiversion": 3,
  "func": "list",
  "module": "BackupInfo",
  "result": {
    "data": [
      {
        "name": "backup-11.128.0.6_2026-06-23_user.tar.gz",
        "fullpath": "backup-11.128.0.6_2026-06-23_user.tar.gz",
        "mtime": 1750636800,
        "sizeBytes": 524288000,
        "status": "ready",
        "startedAtEpoch": 1750636800
      }
    ],
    "status": 1
  }
}