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

Description

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. 

Warnings:

  • 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).

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/VersionControl/delete?repository_root=%2Fhome%2Fuser%2Fexample


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


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


Note:

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

 

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


Note:

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

 

 Command Line
uapi --user=username VersionControl delete repository_root=/home/user/example


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)
{
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{
  
   },
   "data":null
}


Note:

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

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.