cPanel API 2 Functions - Stats::listrawlogs - Knowledgebase

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.

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

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'

)

);

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',

);

cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Stats listrawlogs

Notes:

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

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
link	string	The raw logs URL.	A URL path.	/getaccesslog/accesslog_example.com_10_21_2014.gz",
linked_domains	string	A list of addon domains with raw logs available.	Any valid addon domains on the server. null — No addon domains.
updatetime	string	The log file's last update, in Unix time format.	A Unix timestamp.	1373907782
file	string	The raw logs file.	A valid absolute file path.	/usr/local/apache/domlogs/example.com
txt	string	The domain with raw logs available.	Any valid domain on the server.	example.com
humansize	integer	The formatted size of the file.	Any positive integer, in Kilobytes (K), Megabytes (M), or Gigabytes (G).	1M
size	integer	The size of the file, in bytes.	A positive integer.	1
domain	string	The domain with raw logs available.	Any valid domain on the server.	example.com
type	string	The file type.	Any valid file type.	standard
humanupdatetime	string	The log file's last update.	A timestamp in DDMM HH:MM:SS YYYYformat, 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. YYYYrepresents the four-digit year.	Mon Jul 15 12:03:02 2013
reason	string	A reason for failure. Note: This function only returns areasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories