Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - backup_skip_users_all_status - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - backup_skip_users_all_status
Skip to end of metadata
Go to start of metadata

 

Description

This function checks each user's backup configuration status while the backup_skip_users_all function runs.

Examples 


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


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": {
            "perc": 100,
            "msg": "Done.",
            "running": 0
        },
        "result": 1,
        "command": "backup_skip_users_all_status"
    }
}
 Output (XML)
<result>
   <metadata>
      <version>1</version>
      <reason>
         <perc>100</perc>
         <msg>Done</msg>
         <running>0</running>
      </reason>
      <result>1</result>
      <command>backup_skip_users_all_status</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

ParameterTypeDescriptionPossible valuesExample
reasonhash

A hash that contains backup configuration status information.

This hash includes the percmsg, and running returns.
 

perc

integer

The percentage of users whose backup status has changed.

The function returns this value in the reason hash.

A positive integer.100

msg

string

The function's status.

The function returns this value in the reason hash.

  • No save_all process runnning.
  • Done
Done

running

Boolean

Whether user configuration changes are still in progress.

The function returns this value in the reason hash.

  • 1 — In progress.
  • 0 — Finished.
0