Validate a backup destination

This function validates a backup destination.

SecurityBasicAuth
Request
query Parameters
disableonfail
required
integer

Whether to disable the backup destination if validation fails.

  • 1 — Disable.
  • 0 — Do not disable.
Enum: 0 1
Example: disableonfail=1
id
required
string

The destination's ID.

Example: id=0W1ei2rd3A4lI5sT6he7Be8st
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/backup_destination_validate
Request samples
whmapi1 --output=jsonpretty \
  backup_destination_validate \
  id='0W1ei2rd3A4lI5sT6he7Be8st' \
  disableonfail='1'
Response samples
application/json
{
  • "data": {
    • "id": "0W1ei2rd3A4lI5sT6he7Be8st"
    },
  • "metadata": {
    • "command": "backup_destination_validate",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}