Child pages
  • UAPI Functions - VersionControlDeployment::delete

Versions Compared

Key

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

Description

Excerpt
This function deletes a deployment task.

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

Panel
bgColor#F2F2F2
borderStylenone

Examples  



Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
uapi --user=username VersionControlDeployment delete deploy_id=13

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "errors":null,
   "data":null,
   "status":1,
   "metadata":{  
   },
   "messages":null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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.