UAPI Functions - Bandwidth::get_retention_periods

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(); // Connect to cPanel - only do this once.
  
//Retrieves the retention period for bandwidth data.
$get_periods $cpanel->uapi(
    'Bandwidth''get_retention_periods'
);

 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'
);

 cPanel Template Toolkit

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

 Command Line

uapi user=username Bandwidth get_retention_periods

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
      "transformed":1
   },
   "data":[ 
      
         "retention":2678400,
         "interval":"5min"
      }
   ]
}

 

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

 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

 

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....