cPanel API 2 Functions - Stats::listrawlogs

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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:

When you disable the Web Server role, the system disables this function.

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:

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 include the --user=username option.
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

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 `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`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`