cPanel API 2 Functions - Fileman::viewfile - Knowledgebase

Description

This function lists file information.

Warning:

This function is deprecated as of cPanel version 11.40+. We strongly recommend that you use the following UAPIfunction instead of this function:

Fileman::list_files — This function returns a sorted list of files and directories.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Fileman&cpanel_jsonapi_func=statfiles&dir=public_html&files=file.html%7Cfile2.html%7Cfile3.php

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List information about specific files in /home/user/public_html.
$stat_files = $cpanel->api2(
    'Fileman', 'statfiles',
        array(
        'dir'               => 'public_html'
        'files'             => 'file.html|file2.html|file3.php'
 )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List information about specific files in /home/user/public_html.
my $stat_files = $cpanel->api2(
    'Fileman', 'statfiles',
    {
        'dir'               => 'public_html'
        'files'             => 'file.html|file2.html|file3.php'
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly 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 our Deprecated 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 Fileman statfiles dir=public_html files=file.html%7Cfile2.html%7Cfile3.php

Notes:

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

Output (JSON)

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	The path to the file's directory.	A valid directory path, relative to the user's home directory.	public_html/my_directory
files	string	Required The file's name.	A valid file name. Note: Separate multiple files with the pipe character (\|).	file.html

Parameter

Type

Description

Possible values

Example

dir

string

The path to the file's directory.

A valid directory path, relative to the user's home directory.

public_html/my_directory

files

string

Required

The file's name.

A valid file name.

Note:

Separate multiple files with the pipe character (|).

file.html

Returns

Return	Type	Description	Possible values	Example
mode	string	The file's permissions.	A set of file permissions, in textual representation format.	33188
file	string	The file's name.	A valid filename.	file.html
rawmimetype	string	The file's MIME type.	A valid MIME type.	text/html
nicemode	integer	The file's permissions.	A set of file permissions, in octal notation format.	0777
size	integer	The size of the file.	A positive integer, in bytes.	4096
humansize	string	The formatted size of the file.	A positive integer, in Megabytes (MB), Kilobytes (KB), or Gigabytes (GB).	4 KB
group	string	The file owner's system group name.	A valid group name.	example
fullpath	string	The absolute path to the file.	A valid absolute file path.	/home/example/public_html/file.html
user	string	The file owner's system user name.	A valid system username.	example
ctime	integer	The file's creation time.	A Unix time stamp.	1371711650
uid	integer	The file owner's user ID.	A valid user ID on the server.	517
mtime	integer	The file's last modification time.	A Unix time stamp.	1411211655
mimename	string	The file's MIME name.	A valid MIME name.	text-html
path	string	The absolute path to the file.	A valid absolute file path. This value does not include the file or directory name.	/home/example/public_html
mimeinfo	string	The file's MIME type.	A valid MIME type.	text/html
rawmimename	string	The file's MIME name.	A valid MIME name.	text-html
absdir	string	The absolute path to the directory.	A valid directory, relative to the account's /homedirectory.	home/user/public_html
type	string	The type of the item.	file dir char block fifo link socket	file
gid	integer	The file owner's system group ID.	A valid group ID.	508
reason	string	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.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories