Description

This function validates a backup destination.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_validate?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st&disableonfail=1
https://hostname.example.com:2087/cpsess##########/xml-api/backup_destination_validate?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st&disableonfail=1
whmapi1 backup_destination_validate id=0W1ei2rd3A4lI5sT6he7Be8st disableonfail=1

{
    "data": {
        "id": "0W1ei2rd3A4lI5sT6he7Be8st"
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "backup_destination_validate"
    }
}
<result>
   <data>
      <id>0W1ei2rd3A4lI5sT6he7Be8st</id>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>backup_destination_validate</command>
   </metadata>
</result>

Parameters

ParameterTypeDescriptionPossible valuesExample
idstring

Required

The destination's ID.

 A valid string.0W1ei2rd3A4lI5sT6he7Be8st

disableonfail

Boolean

Required

Whether to disable the backup destination if validation fails.

  • 1 — Disable.
  • 0 — Do not disable.
1

Returns

ReturnTypeDescriptionPossible valuesExample
id string The destination's ID. A valid string.0W1ei2rd3A4lI5sT6he7Be8st