v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
File Restoration

Return backup storage locations

This function lists all of an item's backup locations. An item can be a file, a directory, or a symlink.

Important:

When you disable the File Storage role, the system disables this function.

get/Restore/query_file_info

Query parameters

pathstring path required
Example:/public_html/index.php

A file, directory, or symlink in the user's directory tree.

Note:

The value of this parameter must begin with a forward slash (/).

exists1 | 0

Whether to show the exist return, which indicates whether the item exists in the local disk or only in the backup.

  • 1 — Show the exist return's value.
  • 0 — Do not show the exists return's value.

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": "query_file_info",
  "module": "Restore",
  "result": {
    "data": [
      {
        "backupDate": "2020-07-01T00:00:00.000Z",
        "backupType": "compressed",
        "exists": 1,
        "fileSize": 199,
        "mtime": 1520043240,
        "path": "/public_html/index.php",
        "type": "file"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}