You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - backup_list_transported
Skip to end of metadata
Go to start of metadata

Description

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

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/backup_list_transported?api.version=1&transport=exampletransport
 Command Line
whmapi1 backup_list_transported transport=exampletransport


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
	"data": {
		"remote_backups": {
			"exampletransport": {
				"account1": ["2018-07-19", "2017-07-20"],
				"account2": ["2018-07-19"]
			}
		}
	},
	"metadata": {
		"version": 1,
		"reason": "OK",
		"result": 1,
		"command": "backup_user_list"
	}
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
transportstring

The transport ID.

If you do not specify this parameter, the function returns all transported backup files.

A valid transport ID.

exampletransport

Returns

ReturnTypeDescriptionPossible valuesExample
remote_backups hash A hash of the backup destination information.This hash includes the transport_name hash.

transport_name

hash

The backup transport's name.

Note:

The function uses the name of the transport as the return's name.

The function returns this value in the remote_backups hash.

This hash includes the account_name array.


account_name

string

An array of the account's backup file dates.

Note:

The function uses the name of the account as the return's name.

The function returns this value in the transport_name hash.

A date in YYYY-MM-DD format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
2018-07-19