# Add a backup destination

This function adds a backup destination.

Endpoint: GET /backup_destination_add
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `application_key` (string, required)
    The application key's name.



This parameter is only valid for the  backup type.
    Example: "A123b45CD678e9"

  - `application_key_id` (string, required)
    The application key ID that authenticates the Backblaze B2 account.



This parameter is only valid for the  backup type.
    Example: "12a345B678c9"

  - `authtype` (string, required)
    The authorization type.

* 
* 



This parameter is only valid for the following backup types:
* 
*
    Enum: "password", "key"

  - `aws_access_key_id` (string, required)
    The Amazon S3™ Access Key ID.



This parameter is only valid for the following backup types:
* 
*
    Example: "AKIAYLWMPOZZJCERC28Q"

  - `bucket` (string, required)
    The Amazon S3™ bucket.



This parameter is only valid for the following backup types:
* 
*
    Example: "ChockFullOfNuts"

  - `bucket_id` (string, required)
    The bucket's ID string.



This parameter is only valid for the  backup type.
    Example: "a12b34cd5678e9f"

  - `bucket_name` (string, required)
    The bucket's name.



This parameter is only valid for the  backup type.
    Example: "ChockFullOfNuts"

  - `client_id` (string, required)
    The Google Drive client ID.



This parameter is only valid for the  backup type.
    Example: "aBcdeFgHIjK123"

  - `client_secret` (string, required)
    The Google Drive client secret.



This parameter is only valid for the  backup type.
    Example: "aBcde123FgHIjK456"

  - `disabled` (integer, required)
    Whether to disable the backup destination.

*  — Disable the backup destination.
*  — Enable the backup destination.
    Enum: 0, 1

  - `host` (string, required)
    The remote server's hostname.



This parameter is only valid for the following backup types:
* 
* 
* 
* 
* 
*
    Example: "backups.example.com"

  - `name` (string, required)
    The backup destination's name.
    Example: "destination_name"

  - `password` (string, required)
    The remote server account's password or secret
access key.



This parameter is only valid for the following backup types:
* 
* 
* 
* 
* 
* 
*
    Example: "123456luggage"

  - `script` (string, required)
    The absolute file path to the user-supplied transport solution script.



This parameter is only valid for the  backup type.
    Example: "/home/backups/beammeupscotty.pl"

  - `type` (string, required)
    The type of backup destination.

* 
* 
* 
* 
* 
* 
* 
* 
* 
* 



This value determines which parameters you can use with the function.



Use any of these encrypted connections to transfer system backup files:

* Amazon S3™
* Backblaze
* GoogleDrive
* Rsync
* S3 Compatible
* SFTP
* WebDAV with SSL enabled
    Enum: "Custom", "FTP", "Local", "SFTP", "WebDAV", "AmazonS3", "Rsync", "GoogleDrive", "S3Compatible", "Backblaze"

  - `username` (string, required)
    The remote server account's username.



This parameter is only valid for the following backup types:
* 
* 
* 
* 
*
    Example: "username"

  - `folder` (string)
    The path to the backups directory on the remote server.



This parameter is only valid for the following backup types:
* 
* 
*
    Example: "subfolder"

  - `mount` (integer)
    Whether the path is mounted.

*  — The path is mounted.
*  — The path is  mounted.



This parameter is only valid for the  backup type.
    Enum: 0, 1

  - `no_mount_fail` (integer)
    Whether to fail the backup attempt if the mount fails.

*  — Fail the backup attempt.
*  — Do  fail the backup attempt.



This parameter is only valid for the  backup type.
    Enum: 0, 1

  - `only_used_for_logs` (integer)
    Whether to use this transport only for logs.

*  — This destination will be skipped for regular backups.
*  — Both log and regular backups will be uploaded.

This setting defaults to 0.
The only time log files get their own backup is via scripts/remote_log_transfer
    Enum: 0, 1

  - `passive` (integer)
    Whether to use passive FTP.

*  — Use passive FTP.
*  — Use active FTP.



This parameter is only valid for the  backup type.
    Enum: 0, 1

  - `passphrase` (string)
    The private key file's passphrase, if the  parameter is the  value.



This parameter is only valid for the following backup types:
* 
*
    Example: "123456luggage"

  - `path` (string)
    The path to the backups directory on the remote server.

* This parameter is  for the  backup type.
* If you do  use this parameter, the system will not set a value.



This parameter is only valid for the following backup types:
* 
* 
* 
* 
* 
* 
*
    Example: "backups"

  - `port` (integer)
    The TCP port to use.



* This parameter defaults to the standard port used by the queried backup  parameter.
* This parameter is only valid for the following backup types:
  * 
  * 
  * 
  *
    Example: 21

  - `privatekey` (string)
    The file path to the private key file, if the  parameter is the  value.



This parameter is only valid for the following backup types:
* 
*
    Example: "/home/backups/key"

  - `ssl` (integer)
    Whether to use SSL.

*  — Use SSL.
*  — Do  use SSL.



This parameter is only valid for the  backup type.
    Enum: 0, 1

  - `timeout` (integer)
    The session timeout, measured in seconds.



* This parameter is  valid for the  backup  parameter.
* The default value depends on the  parameter's value.
    Example: 30

  - `upload_system_backup` (integer)
    Whether to upload system backups.

*  — Upload system backups.
*  — Do  upload system backups.
    Enum: 0, 1

## Response 200 fields (application/json):

  - `data` (object)

  - `data.id` (string)
    The backup destination's ID.
    Example: "PhAxIoLSdIkCI40q9vWS4BYy"

  - `metadata` (object)

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

  - `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