- Created by Documentation, last modified on Jun 11, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function enables and disables the backup and legacy backups.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup
https://hostname.example.com:2087/cpsess##########/xml-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup
whmapi1 backup_skip_users_all state=1 backupversion=backup
Notes:
- 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
{ "metadata": { "version": 1, "reason": "Configuration update process started", "result": 1, "command": "backup_skip_users_all" } }
<result> <metadata> <version>1</version> <reason>Configuration update process started</reason> <result>1</result> <command>backup_skip_users_all</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
state | Boolean | Required Whether to enable the backup type that the |
| 1 |
backupversion | string | Required The type of backup. |
| backup |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11.38+
Methods:
GET, POST
Required Parameters:
state
, backupversion
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - toggle_user_backup_state — This function enables or disables legacy backups for a user.
-
Page:WHM API 1 Functions - backup_user_list — This function lists users with a backup file on a specified date.
-
Page:WHM API 1 Functions - backup_date_list — This function lists all dates that contain backup files.
-
Page:WHM API 1 Functions - list_cparchive_files — This function lists all available
cparchive
files. -
Page:WHM API 1 Functions - backup_skip_users_all_status — This function checks each user's backup configuration status while the
backup_skip_users_all
function runs.