Description

This function returns a cPanel account's free disk space quota.

Examples


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$load_settings = $cpanel->api1('OptimizeWS', 'loadoptimizesettings', array('1') ); // Call the function.

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $load_settings = $cpliveapi->api1(OptimizeWS, loadoptimizesettings, ['1']); # Call the function.

<cpanel Module="OptimizeWS::loadoptimizesettings ( $FORM('bytes') )">
cpapi1 --user=username OptimizeWS loadoptimizesettings 1

401.33

Parameters

ParametersTypeDescriptionPossible valuesExample
bytesBoolean

Required

Whether to print the free disk space quota in bytes.

  • 0 — Return free disk space quota, in Megabytes (MB).
  • 1 — Return free disk space quota, in bytes.
all

Returns

This function returns the amount of free disk space.