Child pages
  • UAPI Functions - UserTasks::delete
Skip to end of metadata
Go to start of metadata

Description

This function deletes a process from the user task queue.

Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server.

Examples  


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/UserTasks/delete?id=00000000%2F5a9ec8dd4c345d


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete an item from the user task queue.
$delete = $cpanel->uapi(
    'UserTasks', 'delete',
     array(
        'id'               => '00000000/5a9ec8dd4c345d'
     )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete an item from the user task queue.
my $delete = $cpliveapi->uapi(
    'UserTasks', 'delete',    {
        'id'               => '00000000/5a9ec8dd4c345d'
        },
   }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Delete an item from the user task queue. -->
[% data = execute( 
   'UserTasks', 'delete', {
        'id'               => '00000000/5a9ec8dd4c345d'
   }
); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username UserTasks delete id=00000000\/5a9ec8dd4c345d


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "errors":null,
   "data":{
   },
   "status":1,
   "metadata":{  
   },
   "messages":null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample

id

string

Required

The task's ID number.

A valid task ID.
00000000/5a9ec8dd4c345d

 

Returns

This function only returns metadata.