Return backup files sent through transport

This function lists backup files that the system sent through a specified additional backup transport.

SecurityBasicAuth
Request
query Parameters
transport
string

The transport ID.

If you do not specify this parameter, the function returns backup information for all transports.

Note:

You may obtain the IDs for all configured transports by calling WHM API 1's backup_destination_list function.

Example: transport=nN04BhzirlJUNSLSBXSMBEYG
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/backup_list_transported
Request samples
whmapi1 --output=jsonpretty \
  backup_list_transported
Response samples
application/json
{
  • "data": {
    • "remote_backups": {
      • "nN04BhzirlJUNSLSBXSMBEYG": {
        • "janedoe": [
          • "2020-08-28T00:00:00.000Z",
          • "2020-08-31T00:00:00.000Z",
          • "2020-09-02T00:00:00.000Z"
          ]
        }
      }
    },
  • "metadata": {
    • "command": "backup_list_transported",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}