---
title: "Return a list of backup destinations"
method: GET
path: "/backup_destination_list"
tags: ["Backups", "Backup Destination"]
---

# Return a list of backup destinations

`GET /backup_destination_list`

This function lists backup destinations.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `destination_list` BackupDestinationResponseType[] — An array of objects containing backup destination information.
      - union
        - AmazonS3BackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `aws_access_key_id` string — The Amazon S3 Access Key ID.
          - `bucket` string — The Amazon S3™ bucket.
          - `folder` string — The path to the backups directory, relative to the root directory, on the remote server.
          - `timeout` integer — The session timeout, in seconds.
        - BackblazeBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `application_key` string — The application key's name.
          - `application_key_id` string — The application key ID that authenticates the Backblaze B2 account.
          - `bucket_id` string — The bucket's ID.
          - `bucket_name` string — The bucket's name.
          - `path` string, path — The path to the backups directory on the remote server.
          - `timeout` integer — The session timeout, in seconds.
        - CustomBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `host` string, domain — The remote server's hostname.
          - `path` string, path — The path to the backups directory on the remote server.
          - `script` string — The absolute file path of the user-supplied transport solution script.
          - `timeout` integer — The session timeout, in seconds.
          - `username` string — The remote server account's username.
        - FTPBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `host` string, domain — The remote server's hostname.
          - `passive` integer — Whether to use passive FTP. * `1` - Use passive FTP. * `0` - Use active FTP.
          - `path` string, path — The path to the backups directory on the remote server.
          - `port` integer — The remote server's FTP port.
          - `timeout` integer — The session timeout, in seconds.
          - `username` string — The remote server account's username.
        - GoogleDriveBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `client_id` string — The Google Drive client ID.
          - `client_secret` string — The Google Drive client secret.
          - `folder` string — The path to the backups directory, relative to the root directory, on the remote server.
          - `timeout` integer — The session timeout, in seconds.
        - LocalBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `mount` 1 | 0 — Whether the path is mounted. * `1` - The path is mounted. * `0` - The path is **not** mounted.
          - `no_mount_fail` 1 | 0 — Whether to fail the backup attempt if the mount fails. * `1` - Fail the backup attempt. * `0` - Do **not** fail the backup attempt.
          - `path` string, path — The absolute path to the backups directory.
        - RsyncBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `authtype` 'password' | 'key' — The authorization type. * `password` * `key`
          - `host` string, domain — The remote server's hostname.
          - `path` string, path — The path to the backups directory on the remote server.
          - `port` integer — The remote server's FTP port.
          - `privatekey` string — If the `authtype` return's value is `key`, the absolute path to the private key file.
          - `timeout` integer — The session timeout, in seconds.
          - `username` string — The remote server account's username.
        - S3CompatibleBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `aws_access_key_id` string — The S3-compatible provider key ID.
          - `bucket` string — The S3-compatible bucket.
          - `folder` string — The path to the backups directory, relative to the root directory, on the remote server.
          - `host` string — The S3-compatible provider's server.
          - `timeout` integer — The session timeout, in seconds.
        - SFTPBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `authtype` 'password' | 'key' — The authorization type. * `password` * `key`
          - `host` string, domain — The remote server's hostname.
          - `path` string, path — The path to the backups directory on the remote server.
          - `port` integer — The remote server's FTP port.
          - `privatekey` string — If the `authtype` return's value is `key`, the absolute path to the private key file.
          - `timeout` integer — The session timeout, in seconds.
          - `username` string — The remote server account's username.
        - WebDAVBackupDestinationResponse
          - `disable_reason` string — An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.
          - `disabled` 0 | 1 — Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.
          - `id` string — The ID of the backup destination to modify.
          - `name` string — A new name for the backup destination.
          - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination.
          - `host` string, domain — The remote server's hostname.
          - `path` string, path — The path to the backups directory on the remote server.
          - `port` integer — The remote server's FTP port.
          - `ssl` 1 | 0 — Whether to use SSL. * `1` - Use SSL. * `0` - Do **not** use SSL.
          - `timeout` integer — The session timeout, in seconds.
          - `username` string — The remote server account's username.
  - `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)