# Update the system's backup configuration

This function configures a server's backup system. The system saves these settings in the  file.

Endpoint: GET /backup_config_set
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `backup_daily_enable` (integer)
    Whether to enable daily backups.

*  — Enable.
*  — Disable.
    Enum: 0, 1

  - `backup_daily_retention` (integer)
    The number of daily backups to retain.
    Example: 5

  - `backup_monthly_dates` (integer)
    Which days of the month to run backups.



To add multiple days, use a comma-delimited list.
    Example: 1

  - `backup_monthly_enable` (integer)
    Whether to enable monthly backups.

*  — Enable.
*  — Disable.
    Enum: 0, 1

  - `backup_monthly_retention` (integer)
    The number of monthly backups to retain.
    Example: 5

  - `backup_weekly_day` (integer)
    Which day of the week to run weekly backups.

*  — Sunday.
*  — Monday.
*  — Tuesday.
*  — Wednesday.
*  — Thursday.
*  — Friday.
*  — Saturday.
    Example: 1

  - `backup_weekly_enable` (integer)
    Whether to enable weekly backups.

*  — Enable.
*  — Disable.
    Enum: 0, 1

  - `backup_weekly_retention` (integer)
    The number of weekly backups to retain.
    Example: 4

  - `backupaccts` (integer)
    Whether to back up cPanel user accounts.

*  — Back up.
*  — Do  back up.



This setting affects whether the system enables the 
interfaces in
cPanel
and in
WHM.
For more information, read the
How to Manage Metadata Settings
documentation.
    Enum: 0, 1

  - `backupbwdata` (integer)
    Whether to back up bandwidth tracking data.

*  — Back up.
*  — Do  back up.
    Enum: 0, 1

  - `backupdays` (string)
    Which days of the week to run daily backups.

*  — Sunday.
*  — Monday.
*  — Tuesday.
*  — Wednesday.
*  — Thursday.
*  — Friday.
*  — Saturday.



For multiple days, use a comma-delimited list.
    Example: "0,1,2,3,4,5,6"

  - `backupdir` (string)
    The primary backup directory.
    Example: "/backup"

  - `backupenable` (integer)
    Whether to enable backups.

*  — Enable.
*  — Disable.



This setting affects whether the system enables the 
interfaces in
cPanel
and in
WHM.
For more information, read the
How to Manage Metadata Settings
documentation.
    Enum: 0, 1

  - `backupfiles` (integer)
    Whether to back up system files.

*  — Back up.
*  — Do  back up.
    Enum: 0, 1

  - `backuplogs` (integer)
    Whether to back up the error logs.

*  — Back up.
*  — Do  back up.
    Enum: 0, 1

  - `backupmount` (integer)
    Whether to mount a backup partition.

*  — Mount.
*  — Do  mount.



This setting affects whether the system enables the 
interfaces in
cPanel
and in
WHM.
For more information, read the
How to Manage Metadata Settings
documentation.
    Enum: 0, 1

  - `backupsuspendedaccts` (integer)
    Whether to back up suspended accounts.

*  — Back up.
*  — Do  back up.
    Enum: 0, 1

  - `backuptype` (string)
    The type of backup to create.

* 
* 
*
    Enum: "compressed", "uncompressed", "incremental"

  - `check_min_free_space` (integer)
    Whether to ensure that the destination server possesses the minimum
free disk space available.

*  — Check the free disk space on the destination server.
*  — Do  check the free disk space on the destination server.
    Enum: 0, 1

  - `disable_metadata` (integer)
    Whether the backup system will create metadata when a backup runs.

*  — Disable metadata creation.
*  — Enable metadata creation.



This setting affects whether the system enables the 
interfaces in
cPanel
and in
WHM.
For more information, read the
How to Manage Metadata Settings
documentation.
    Enum: 0, 1

  - `errorthreshhold` (integer)
    The number of times that the system will try to use the additional backup destination.
    Example: 3

  - `force_prune_daily` (integer)
    Whether to strictly enforce the value of the 
parameter.

*  — Strictly enforce the  parameter.
*  — Only enforce the  parameter  a
successful complete backup.
    Enum: 0, 1

  - `force_prune_monthly` (integer)
    Whether to strictly enforce the value of the 
parameter.

*  — Strictly enforce the  parameter.
*  — Only enforce the  parameter  a
successful complete backup.
    Enum: 0, 1

  - `force_prune_weekly` (integer)
    Whether to strictly enforce the value of the 
parameter.

*  — Strictly enforce the  parameter.
*  — Only enforce the  parameter  a
successful complete backup.
    Enum: 0, 1

  - `gziprsyncopts` (string)
    The  environment variables.
    Example: "--rysncable"

  - `keeplocal` (integer)
    Whether to delete backups from the local directory.

*  — Delete.
*  — Do  delete.



This setting affects whether the system enables the 
interfaces in
cPanel
and in
WHM.
For more information, read the
How to Manage Metadata Settings
documentation.
    Enum: 0, 1

  - `linkdest` (integer)
    Whether to check the  function for hardlink support.

*  — Check.
*  — Do  check.
    Enum: 0, 1

  - `localzonesonly` (integer)
    Whether to use a local zone file from the 
file or the  daemon, where  represents the target domain.

*  — Use the  file.
*  — Use .
    Enum: 0, 1

  - `maximum_restore_timeout` (integer)
    How long a restoration will attempt to run, in seconds. If the restoration does not succeed in this amount of time, it will stop.
    Example: 21600

  - `maximum_timeout` (integer)
    How long a backup will attempt to run, in seconds. If the backup does not succeed in this amount of time, it will stop.
    Example: 7200

  - `min_free_space` (integer)
    The minimum amount of free disk to check for on the destination server.



If the value of the  parameter is , the maximum
value is .
    Example: 1024

  - `min_free_space_unit` (string)
    The units of measurement of disk space for the  return.

*  — Megabytes.
*  — Percent available.
    Enum: "MB", "percent"

  - `mysqlbackup` (string)
    The backup method to use for MySQL® databases.

*  — Back up databases in each account's archive.
*  — Back up the entire MySQL directory.
*  — Back up databases in each account's archive and the entire
MySQL directory.
    Enum: "accounts", "dir", "both"

  - `postbackup` (integer)
    Whether to run the  script after
the backup finishes.

*  — Run.
*  — Do  run.
    Enum: 0, 1

  - `prebackup` (integer)
    Whether to run the  script before
the system processes backups.

*  — Run.
*  — Do  run.
    Enum: 0, 1

  - `psqlbackup` (integer)
    Whether to back up PostgreSQL® databases.

*  — Back up.
*  — Do  back up.
    Enum: 0, 1

  - `remote_restore_staging_dir` (string)
    The directory that temporarily stores a remote backup's data during a backup restoration.
The data is a compressed () or uncompressed () account tarball.



The system restores backups one at a time. The backup staging directory 
be large enough to contain the largest remote backup file that you wish to restore.
For example, if you wish to restore three backups, sized 1.5 GB, 528 MB, and
950 MB each, your backup staging directory must be able to hold at  1.5 GB.



The system empties the directory after the system restores the backup.
    Example: "/backup"

## Response 200 fields (application/json):

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "backup_config_set"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is . This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1