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
LiveAPI PHP Class
$cpanel = new CPANEL();
$get_periods = $cpanel->uapi(
'Bandwidth', 'get_retention_periods'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $get_periods = $cpliveapi->uapi(
'Bandwidth', 'get_retention_periods'
);
cPanel Template Toolkit
[% execute('Bandwidth', 'get_retention_periods') %]
Command Line
uapi user=username Bandwidth get_retention_periods
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
"transformed":1
},
"data":[
{
"retention":2678400,
"interval":"5min"
}
]
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
data
|
array
|
An array of the account's backup files.
|
A comma-separated list of dates in YYYY-MM-DD format, where:
- YYYY represents the year.
- MM represents the month.
- DD represents the date.
|
2014-12-02
|
