Child pages
  • WHM API 1 Functions - backup_date_list

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists all dates that contain backup files.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/backup_date_list?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/backup_date_list?api.version=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 backup_date_list

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

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