Update backup destination settings

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

SecurityBasicAuth
Request
Request Body schema: application/x-www-form-urlencoded

The destination settings.

disable_reason
string

An error message that explains why the backup is disabled.

disabled
integer

Whether to disable the backup destination.

  • 1 — Disable the destination.
  • 0 — Enable the destination.

Note:

If you do not set this parameter, the system retains the current setting.

Enum: 0 1
id
required
string

The ID of the backup destination to modify.

name
string

A new name for the backup destination.

Note:

If you do not set this parameter, the system retains the current setting.

type
string

The type of backup destination.

Note:

If you do not set this parameter, the system retains the current setting.

Select a backup destination from the following menu to view its optional parameters:

upload_system_backup
integer

Whether to upload system backups.

  • 1 — Upload.
  • 0 — Do not upload.

Note:

If you do not set this parameter, the system retains the current setting.

Enum: 0 1
only_used_for_logs
integer

Whether to use this transport only for logs.

  • 1 — This destination will be skipped for regular backups.
  • 0 — 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

Note:

If you do not set this parameter, the system retains the current setting.

Enum: 0 1
aws_access_key_id
required
string

The Amazon S3 Access Key ID.

bucket
required
string

The Amazon S3™ bucket.

folder
string <path>
Default: ""

The path to the backups directory, relative to the root directory, on the remote server.

password
required
string

The Amazon S3 Access Key's password.

timeout
required
integer [ 30 .. 300 ]
Default: 30

The session timeout, in seconds.

Responses
200

HTTP Request was successful.

Response Schema: application/json
object
post/backup_destination_set
Request samples
whmapi1 --input=json --output=jsonpretty \
  backup_destination_set
Response samples
application/json
{
  • "metadata": {
    • "command": "backup_destination_set",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}