Return backups in home directory

This function lists all of the backup files and directories in the user's home directory.

Important:

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

SecurityBasicAuth

Request

query Parameters

path

required

string

A path to a subdirectory within the user's home directory, or any level below it.

Note:

The value of this parameter must begin and end with a forward slash (/) for security purposes.

Example: path=/public_html/

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/directory_listing

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Restore \
  directory_listing \
  path='/public_html/'

Response samples

application/json

{"apiversion": 3,
"func": "directory_listing",
"module": "Restore",
"result": {"data": [{"conflict": 0,
"exists": 1,
"name": "public_html",
"onDiskType": "file",
"type": "file"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}