Return a list of backup destinations

This function lists backup destinations.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  backup_destination_list

Response samples

Content type
application/json
{
  • "data": {
    • "destination_list": [
      • {
        • "disable_reason": "Could not list files in destination: example",
        • "disabled": 0,
        • "id": "0W1ei2rd3A4lI5sT6he7Be8st",
        • "name": "destination_name",
        • "type": "Local",
        • "aws_access_key_id": "s123456789",
        • "bucket": "ChockFullOfNuts",
        • "folder": "subfolder",
        • "timeout": 300
        }
      ]
    },
  • "metadata": {
    • "command": "backup_destination_list",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}