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

 

Description

This function removes a backup destination from the backup configuration file.

Examples 


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


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/api/whmapi1

 Output (JSON)
{
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "backup_destination_delete"
    }
}

 Output (XML)
<result>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>backup_destination_delete</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.11111111

Returns

This function only returns metadata.