---
title: "Add a backup destination"
method: GET
path: "/backup_destination_add"
tags: ["Backups", "Backup Destination"]
---

# Add a backup destination

`GET /backup_destination_add`

This function adds a backup destination.

## Query parameters

- `application_key` string, required
- `application_key_id` string, required
- `authtype` 'password' | 'key', required
- `aws_access_key_id` string, required
- `bucket` string, required
- `bucket_id` string, required
- `bucket_name` string, required
- `client_id` string, required
- `client_secret` string, required
- `disabled` 0 | 1, required
- `host` string, hostname, required
- `name` string, required
- `password` string, required
- `script` string, required
- `type` 'Custom' | 'FTP' | 'Local' | 'SFTP' | 'WebDAV' | 'AmazonS3' | 'Rsync' | 'GoogleDrive' | 'S3Compatible' | 'Backblaze', required
- `username` string, username, required
- `folder` string
- `mount` 0 | 1
- `no_mount_fail` 0 | 1
- `only_used_for_logs` 0 | 1
- `passive` 0 | 1
- `passphrase` string
- `path` string
- `port` integer
- `privatekey` string
- `ssl` 0 | 1
- `timeout` integer
- `upload_system_backup` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `id` string — The backup destination's ID.
  - `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)