---
title: "Update the system's backup configuration"
method: GET
path: "/backup_config_set"
tags: ["Backups", "Backup Settings"]
---

# Update the system's backup configuration

`GET /backup_config_set`

This function configures a server's backup system. The system saves these settings in the `/var/cpanel/backups/config` file.

## Query parameters

- `backup_daily_enable` 0 | 1
- `backup_daily_retention` integer
- `backup_monthly_dates` integer
- `backup_monthly_enable` 0 | 1
- `backup_monthly_retention` integer
- `backup_weekly_day` integer
- `backup_weekly_enable` 0 | 1
- `backup_weekly_retention` integer
- `backupaccts` 0 | 1
- `backupbwdata` 0 | 1
- `backupdays` string
- `backupdir` string
- `backupenable` 0 | 1
- `backupfiles` 0 | 1
- `backuplogs` 0 | 1
- `backupmount` 0 | 1
- `backupsuspendedaccts` 0 | 1
- `backuptype` 'compressed' | 'uncompressed' | 'incremental'
- `check_min_free_space` 0 | 1
- `disable_metadata` 0 | 1
- `errorthreshhold` integer
- `force_prune_daily` 0 | 1
- `force_prune_monthly` 0 | 1
- `force_prune_weekly` 0 | 1
- `gziprsyncopts` string
- `keeplocal` 0 | 1
- `linkdest` 0 | 1
- `localzonesonly` 0 | 1
- `maximum_restore_timeout` integer
- `maximum_timeout` integer
- `min_free_space` integer
- `min_free_space_unit` 'MB' | 'percent'
- `mysqlbackup` 'accounts' | 'dir' | 'both'
- `postbackup` 0 | 1
- `prebackup` 0 | 1
- `psqlbackup` 0 | 1
- `remote_restore_staging_dir` string

## Response `200`

HTTP Request was successful.

- object
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)