Child pages
  • cPanel API 1 Functions - LeechProtect::status

Versions Compared

Key

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

 

Description

Excerpt

This function displays a directory's leech protection status.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$status_leech = $cpanel->api1('LeechProtect','status', array('/home/username/public_html/protected_directory/') ); // Call the function.

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.
my $status_leech = $cpliveapi->api1('LeechProtect', 'status', ['/home/username/public_html/protected_directory/']); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="LeechProtect::status( $FORM('dir'))">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username LeechProtect status /home/username/public_html/protected_directory/

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
enabled

 




Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory's path.

A valid absolute directory path.
/home/username/public_html/protected_directory/

 

Returns

  • enabled — LeechProtect is enabled.
  • disabled — LeechProtect is disabled.