Child pages
  • WHM API 1 Functions - restore_queue_clear_completed_task

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_clear_completed_tasks?api.version=1&user=user&start_time=1396065600
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/restore_queue_clear_completed_tasks?api.version=1&user=user&start_time=1396065600
Expand
titleCommand Line
Code Block
languagebash
whmapi1 restore_queue_clear_completed_tasks user=user start_time=1396065600

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "restore_queue_clear_completed_tasks"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>restore_queue_clear_completed_tasks</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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.