Child pages
  • cPanel API 2 Functions - Stats::listrawlogs
Skip to end of metadata
Go to start of metadata

Description

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


Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 WHM API (JSON)
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


Note:

 For more information, read our Calls from the WHM API documentation.

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


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 domains with rawlogs available.
my $list_raw_logs = $cpliveapi->api2(
    'Stats', 'listrawlogs',
 );


Note:

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

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Stats listrawlogs


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "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"
  }
}


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
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.

Note:

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