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

 

Description

This function removes a single completed task from the restoration queue.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_completed_tasks?api.version=1&user=user&start_time=1396065600
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/restore_queue_clear_completed_tasks?api.version=1&user=user&start_time=1396065600
 Command Line
whmapi1 restore_queue_clear_completed_tasks user=user start_time=1396065600


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)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "restore_queue_clear_completed_tasks"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>restore_queue_clear_completed_tasks</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account's username.

A valid cPanel account's username.user
start_timeinteger

Required

When the restoration queue started the restoration.

A time in Unix time format.

1396065600

 

Returns

This function only returns metadata.