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

 

Description

This function lists backup files on the server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/backup_set_list?api.version=1
 Command Line
whmapi1 backup_set_list


Notes:

  • 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": {
    "backup_set": [
      {
        "user": "username",
        "backup_date": [
          "2014-01-07",
          "2014-01-06",
          "2014-01-05",
          "2014-01-04",
          "2014-01-03"
        ]
      },
      {
        "user": "example",
        "backup_date": [
          "2014-01-07",
          "2014-01-06",
          "2014-01-05",
          "2014-01-04",
          "2014-01-03"
        ]
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "backup_set_list"
  }
}
 Output (XML)
<result>
   <data>
      <backup_set>
         <user>example</user>
         <backup_date>2014-01-07</backup_date>
         <backup_date>2014-01-06</backup_date>
         <backup_date>2014-01-05</backup_date>
         <backup_date>2014-01-04</backup_date>
         <backup_date>2014-01-03</backup_date>
      </backup_set>
      <backup_set>
         <user>example</user>
         <backup_date>2014-01-07</backup_date>
         <backup_date>2014-01-06</backup_date>
         <backup_date>2014-01-05</backup_date>
         <backup_date>2014-01-04</backup_date>
         <backup_date>2014-01-03</backup_date>
      </backup_set>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>backup_set_list</command>
   </metadata>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
backup_sethashA hash of a user's backup information.This hash includes the user and backup_date returns. 

user

string

The backup file set's owner.

The function returns this value in the backup_set hash.

A valid username.username

backup_date

array of strings

The backup file's date.

The function returns this value in the backup_set hash.

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

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.

2014-01-01