Developer Documentation
Child pages
  • WHM API 1 Functions - backup_skip_users_all
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description


This function enables and disables the backup and legacy backups.

Examples 

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


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)
{
    "metadata": {
        "version": 1,
        "reason": "Configuration update process started",
        "result": 1,
        "command": "backup_skip_users_all"
    }
}
 Output (XML)
<result>
   <metadata>
      <version>1</version>
      <reason>Configuration update process started</reason>
      <result>1</result>
      <command>backup_skip_users_all</command>
   </metadata>
</result>


Note:

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

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.

Function information

API Version:

WHM API 1

Available in:

WHM 11.38+

Methods:

GET, POST

Required Parameters:

state, backupversion

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions