Description

This function displays the domains that have raw log downloads available.

Examples




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Stats&cpanel_jsonapi_func=listrawlogs



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List domains with raw logs available.
$list_raw_logs = $cpanel->api2(
    'Stats', 'listrawlogs'
    ) 
 );

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List domains with rawlogs available.
my $list_raw_logs = $cpliveapi->api2(
    'Stats', 'listrawlogs',
 );




cpapi2 --user=username Stats listrawlogs



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listrawlogs",
    "data": [
      {
        "link": "/cpsess4702814203/getaccesslog/accesslog_colin.com_10_20_2014.gz",
        "linked_domains": null,
        "updatetime": 1373907782,
        "file": "/usr/local/apache/domlogs/colin.com",
        "txt": "example.com",
        "humansize": "None",
        "size": 1,
        "domain": "example.com",
        "type": "standard",
        "humanupdatetime": "Mon Jul 15 12:03:02 2013"
      },
    ],
    "event": {
      "result": 1
    },
    "module": "Stats"
  }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
linkstringThe raw logs URL.A URL path.
/getaccesslog/accesslog_example.com_10_21_2014.gz",
linked_domainsstring

A list of addon domains with raw logs available.

 

  • Any valid addon domains on the server.
  • null — No addon domains.
 
updatetimestringThe log file's last update, in Unix time format.A Unix timestamp.
1373907782
filestringThe raw logs file.A valid absolute file path.
/usr/local/apache/domlogs/example.com
txtstringThe domain with raw logs available.Any valid domain on the server.example.com
humansizeintegerThe formatted size of the file.Any positive integer, in Kilobytes (K), Megabytes (M), or Gigabytes (G).1M
sizeintegerThe size of the file, in bytes.A positive integer.1
domainstringThe domain with raw logs available.Any valid domain on the server.example.com
typestringThe file type.Any valid file type.standard
humanupdatetimestringThe log file's last update.

A timestamp in DD MM HH:MM:SS YYYY format, where:

  • DD represents the two-digit date.
  • MM represents the two-digit month.
  • HH represents the two-digit hour.
  • MM represents the two-digit minute.
  • SS represents the two-digit second.
  • YYYY represents the four-digit year.
Mon Jul 15 12:03:02 2013
reasonstring

A reason for failure.

This function only returns a reason value if there was an error.


A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1