CPcpanel
Backups
Backup Destination

Update backup destination settings

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

post/backup_destination_set

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "disable_reason": "Could not list files in destination: example",
  "id": "0W1ei2rd3A4lI5sT6he7Be8st",
  "name": "destination_name",
  "type": "Local",
  "upload_system_backup": 1,
  "only_used_for_logs": 1,
  "aws_access_key_id": "s123456789",
  "bucket": "ChockFullOfNuts",
  "folder": "subfolder",
  "password": "123456luggage",
  "timeout": 300
}

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "backup_destination_set",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.