CPcpanel
BackupInfo

Return cPanel account backups

Changed on

This function returns one entry for each cPanel account backup archive in the current cPanel account's home directory.

Note: The function derives each archive's status from the on-disk marker file that cPanel writes while a backup runs. It is the single source of truth for the list of available backups.

get/BackupInfo/list

Request

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

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": "list",
  "module": "BackupInfo",
  "result": {
    "data": [
      {
        "fullpath": "backup-11.128.0.6_2026-06-23_user.tar.gz",
        "mtime": 1750636800,
        "name": "backup-11.128.0.6_2026-06-23_user.tar.gz",
        "sizeBytes": 524288000,
        "startedAtEpoch": 1750636800,
        "status": "ready"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes

  • 99adb57e7a5dRevision 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 list removed and replaced with BackupInfo-list

    • info

      added the optional property / to the response with the status