Child pages
  • WHM API 1 Functions - backup_skip_users_all

Versions Compared

Key

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

Description


Excerpt

This function enables and disables the backup and legacy backups.


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup



Expand
titleCommand Line


Code Block
languagebash
whmapi1 backup_skip_users_all state=1 backupversion=backup

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "metadata": {
        "version": 1,
        "reason": "Configuration update process started",
        "result": 1,
        "command": "backup_skip_users_all"
    }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
   <metadata>
      <version>1</version>
      <reason>Configuration update process started</reason>
      <result>1</result>
      <command>backup_skip_users_all</command>
   </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
stateBoolean

Required

Whether to enable the backup type that the backupversion parameter specifies for all users.

  • 1 — Enable.
  • 0 — Disable.
1
backupversionstring

Required

The type of backup.

  • backup
  • legacy
backup

Returns

This function only returns metadata.