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

 

Description

This function retrieves the retention periods for bandwidth data.

Examples 


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


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.
 
//Retrieves the retention period for bandwidth data.
$get_periods = $cpanel->uapi(
    'Bandwidth', 'get_retention_periods'
);

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.
 
# Retrieves the retention period for bandwidth data.
my $get_periods = $cpliveapi->uapi(
    'Bandwidth', 'get_retention_periods'
);

Note:

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

 cPanel Template Toolkit
<!-- Retrieves the retention period for bandwidth data. -->
[% execute('Bandwidth', 'get_retention_periods') %]

Note:

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

 Command Line
uapi --user=username Bandwidth get_retention_periods

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":{  
      "transformed":1
   },
   "data":[  
      {  
         "retention":2678400,
         "interval":"5min"
      }
   ]
}

Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
intervalstring

The interval in which the system reports bandwidth data.

  • daily
  • hourly
  • 5min
5min
retentionstring

The retention period for bandwidth data.

A date in Unix time format

2678400