Description

This function deletes a deployment task.

 For more information, read our Guide to Git - Deployment documentation.

Examples  





https://hostname.example.com:2083/cpsess##########/execute/VersionControlDeployment/delete?deploy_id=13



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete a deployment task.
$delete = $cpanel->uapi(
    'VersionControlDeployment', 'delete',
     array(
        'deploy_id'    => '13';
     )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete a deployment task.
my $delete = $cpliveapi->uapi(
    'VersionControlDeployment', 'delete',    {
        'deploy_id'    => '13',
    }
);

 



<!-- Delete a deployment task. -->
[% data = execute( 
   'VersionControlDeployment', 'delete', {
        'deploy_id'    => '13',
   } 
); %]

 



uapi --user=username VersionControlDeployment delete deploy_id=13



{  
   "errors":null,
   "data":null,
   "status":1,
   "metadata":{  
   },
   "messages":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
deploy_idstring

Required

The Task Queue system's task ID number.

A valid task ID.

13

 

Returns

This function only returns metadata.