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.

SecurityBasicAuth
Request
query Parameters
path
required
string <path>

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

Note:

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

Example: path=/public_html/index.php
exists
integer
Default: 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.
Enum: 1 0
Example: exists=0
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Restore/query_file_info
Request samples
uapi --output=jsonpretty \
  --user=username \
  Restore \
  query_file_info \
  path='/public_html/index.php'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "query_file_info",
  • "module": "Restore",
  • "result": {
    • "data": [
      • {
        • "backupDate": "2020-07-01T00:00:00.000Z",
        • "backupID": "weekly/2017-07-01",
        • "backupType": "compressed",
        • "exists": 1,
        • "fileSize": 199,
        • "mtime": 1520043240,
        • "path": "/public_html/index.php",
        • "type": "file"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}