---
title: "Return a backup destination's settings"
method: GET
path: "/backup_destination_get"
tags: ["Backups", "Backup Destination"]
---

# Return a backup destination's settings

`GET /backup_destination_get`

Use this function to obtain a backup destination's settings.

## Query parameters

- `id` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` union
    - BackupDestinationGetResponseAmazonS3
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `aws_access_key_id` string — The Amazon S3 Access Key ID.
      - `bucket` string — The Amazon S3™ bucket.
      - `folder` string, path — The path to the backups directory, relative to the root directory, on the remote server.
      - `timeout` integer — The session timeout, in seconds.
    - BackupDestinationGetResponseBackblaze
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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.
    - BackupDestinationGetResponseCustom
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `host` string, domain — The remote server's hostname.
      - `path` string, path — The path to the backups directory on the remote server.
      - `script` string, path — 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.
    - BackupDestinationGetResponseFTP
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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.
    - BackupDestinationGetResponseGoogleDrive
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `client_id` string — The Google Drive client ID.
      - `client_secret` string — The Google Drive client secret.
      - `folder` string, path — The path to the backups directory, relative to the root directory, on the remote server.
      - `timeout` integer — The session timeout, in seconds.
    - BackupDestinationGetResponseLocal
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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.
    - BackupDestinationGetResponseRsync
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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, path — 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.
    - BackupDestinationGetResponseS3Compatible
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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, domain — The S3-compatible provider's server.
      - `timeout` integer — The session timeout, in seconds.
    - BackupDestinationGetResponseSFTP
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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, path — 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.
    - BackupDestinationGetResponseWebDAV
      - `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 backup destination's ID
      - `name` string — The backup destination's name.
      - `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze' — The type of backup destination. Select a backup destination from the following menu to view its return values:
      - `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)