---
title: "Return backup configuration file data"
method: GET
path: "/backup_config_get"
tags: ["Backups", "Backup Settings"]
---

# Return backup configuration file data

`GET /backup_config_get`

This function retrieves your backup destination configuration file data.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `backup_config` object — A list of backup configuration data.
      - `backup_daily_enable` 0 | 1 — Whether daily backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backup_daily_retention` integer — The number of retained daily backups.
      - `backup_monthly_dates` string — A comma-seprated list of the days of the month on which the system runs monthly backups.
      - `backup_monthly_enable` 0 | 1 — Whether monthly backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backup_monthly_retention` integer — The number of retained monthly backups.
      - `backup_weekly_day` string — The day of the week on which the system runs weekly backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday.
      - `backup_weekly_enable` 0 | 1 — Whether weekly backups are enabled. * `1` — Enable. * `0` — Disable.
      - `backup_weekly_retention` integer — The number of retained weekly backups.
      - `backupaccts` 1 | 0 — Whether to back up accounts. * `1` — Back up. * `0` — Do **not** back up. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interface in cPanel & WHM. For more information, read the [How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings) documentation.
      - `backupbwdata` 0 | 1 — Whether bandwidth tracking data backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backupdays` string — The days of the week on which the system runs daily backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday.
      - `backupdir` string — The aboslute file path to the server's local backup directory.
      - `backupenable` 1 | 0 — Whether backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backupfiles` 0 | 1 — Whether system file backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backuplogs` 0 | 1 — Whether error log backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backupmount` 0 | 1 — Whether the system mounts backup partitions as part of the backup process. * `1` — Mounted. * `0` — **Not** mounted. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interface in cPanel & WHM. For more information, read the [How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings) documentation.
      - `backupsuspendedaccounts` 0 | 1 — Whether suspended account backups are enabled. * `1` — Enabled. * `0` — Disabled.
      - `backuptype` 'compressed' | 'uncompressed' | 'incremental' — The type of backup file the system creates. * `compressed` — A compressed `.tar` file. * `uncompressed` — An uncompressed `.tar` file. * `incremental` — A full tree of files and directories.
      - `check_min_free_space` 0 | 1 — Whether the system performs a check of the minimum free disk space available on the destination server. * `1` — Check the free disk space on the destination server. * `0` — Do **not** check the free disk space on the destination server.
      - `disable_metadata` 1 | 0 — Whether the backup system creates metadata when a backup runs. * `1` — Disables metadata creation. * `0` — Enables metadata creation.
      - `errorthreshhold` integer — The number of times that the system attempts to use the additional backup destination.
      - `force_prune_daily` 0 | 1 — Whether the `backup_daily_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_daily_retention` setting after a backup successfully completes.
      - `force_prune_monthly` 0 | 1 — Whether the `backup_monthly_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_monthly_retention` setting after a backup successfully completes.
      - `force_prune_weekly` 0 | 1 — Whether the `backup_weekly_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_weekly_retention` setting after a backup successfully completes.
      - `gziprsyncopts` string — The environment variables passed to the `gzip` application. The system uses these variables to adjust how the `gzip` application runs when compressing backups.
      - `keeplocal` 0 | 1 — Whether the system deletes backups from the local directory. * `1` — The system does not delete backups from the local backup directory. * `0` — The system **deletes** backups from the local directory. **Note:** The `backupdir` return value contains the local backup directory.
      - `linkdest` 0 | 1 — Whether the system checks the `rsync` function for hardlink support. * `1` — Enabled. * `0` — Disabled.
      - `localzonesonly` 0 | 1 — Whether the system uses a local zone file from the `dnsadmin` daemon or `/var/named/domain.tld` file, where `domain.tld` is the target domain. * `1` — The system uses the `/var/named/domain.tld` file. * `0` — The system uses the `dnsadmin` daemon.
      - `maximum_restore_timeout` integer — The maximum interval, in seconds, that the restoration attempts a run to completion. If the restoration takes longer than this interval, the system terminates the restoration.
      - `maximum_timeout` integer — The maximum interval, in seconds, that the backup attempts a run to completion. If the backup takes longer than this interval, the system terminates the backup.
      - `min_free_space` integer — The minimum amount of free disk space the system checks for on the destination server before attempting a backup to that server.
      - `min_free_space_unit` 'MB' | 'percent' — The unit of measure of disk space for the `min_free_space` return. * `MB` — Megabytes. * `percent` — Percentages.
      - `mysqlbackup` string — The method that the system uses to back up MySQL® databases. * `accounts` — Backs up databases into each account's archive. * `dir` — Backs up the entire MySQL directory. * `both` — Back up databases into each account's archive **and** the entire MySQL directory.
      - `postbackup` 0 | 1 — Whether the `/usr/local/cpanel/scripts/postcpbackup` script runs after the backup completes. * `1` — Enabled. * `0` — Disabled.
      - `prebackup` 0 | 1 — Whether the `/usr/local/cpanel/scripts/precpbackup` script runs before the system processes backups. * `1` — Enabled. * `0` — Disabled.
      - `psqlbackup` 0 | 1 — Whether backups of PostgreSQL® databases are enabled. * `1` — Enabled. * `0` — Disabled.
      - `remote_restore_staging_dir` string — The directory on the local server where the system temporarily stores a remote server's backup file during a backup restoration.
  - `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)