Child pages
  • UAPI Functions - VersionControl::delete

Versions Compared

Key

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

Description

Excerpt
This function deletes a cPanel account's Git™ repository.

 For more information about support for version control in cPanel & WHM, read our Git Version Control and Guide to Git documentation. 

Warning
titleWarnings:
  • When you call this function, the system permanently deletes the entire contents of the specified directory. You cannot recover this data after deletion.
  • You cannot use this function to delete any repositories that do not appear in the cache of repositories (for example, repositories that contain invalid characters or exist within cPanel-controlled directories).


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/VersionControl/delete?repository_root=%2Fhome%2Fuser%2Fexample

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 repository.
$delete = $cpanel->uapi(
    'VersionControl', 'delete',
     array(
        'repository_root'   => '/home/user/example',
)
);

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 repository.
my $delete = $cpliveapi->uapi(
    'VersionControl', 'delete',    {
        'repository_root'   => '/home/user/example',
   }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Delete a repository. -->
[% data = execute( 
   'VersionControl', 'delete', {
        'repository_root'   => '/home/user/example',
   } 
); %]

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
uapi --user=username VersionControl delete repository_root=/home/user/example

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample

repository_root

string

Required

The directory that contains the repository to delete.

 A valid absolute path to a repository's directory within the user's home directory.


/home/user/example

 Returns

This function only returns metadata.