Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function returns the disk space that the main account uses.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_main_account_disk_usage_bytes


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.
 
// List disk usage for the main account in bytes.
$disk_used = $cpanel->uapi(
    'Email', 'get_main_account_disk_usage_bytes'
);

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.
 
# List disk usage for the main account in bytes.
my $disk_used = $cpliveapi->uapi(
    'Email', 'get_main_account_disk_usage_bytes',
);

Note:

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

 

 cPanel Template Toolkit
<!-- Get only the disk use in bytes. -->
[% execute('Email', 'get_main_account_disk_usage_bytes', ) %]

Note:

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

 

 Command Line
uapi --user=username Email get_main_account_disk_usage_bytes

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
   },
   "data":"3076"
}

Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

data

integerThe current amount of disk space that the main email account uses.

A numeric value, in bytes.

3076