We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function lists all dates that contain backup files, whether stored locally or stored on backup destinations when local backups are disabled.

Examples 


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


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": {
    "backup_set": [
      "2014-01-07",
      "2014-01-06",
      "2014-01-05",
      "2014-01-04",
      "2014-01-03"
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "backup_date_list"
  }
}
 Output (XML)
<result>
   <data>
      <backup_set>2014-01-07</backup_set>
      <backup_set>2014-01-06</backup_set>
      <backup_set>2014-01-05</backup_set>
      <backup_set>2014-01-04</backup_set>
      <backup_set>2014-01-03</backup_set>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>backup_date_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_set array of strings The date that contains backup files.

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

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

2014-01-01