Child pages
  • WHM API 1 Functions - backup_destination_validate
Skip to end of metadata
Go to start of metadata

 

Description

This function validates a backup destination.

Examples 


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


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

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


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

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