cPanel API 2 Functions - Fileman::search

Description

This function recursively searches for a file within a directory.

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=Fileman&cpanel_jsonapi_func=search&dir=%2Fhome%2Fexample&attributes=user%7Cgroupusage%7Csize%7Ctype%7Cmode%7Cctime%7Catime%7Cmtime

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Search for files that begin with /home/example
$search_files $cpanel->api2(
    'Fileman''search',
        array(
        'dir'           => 'home/example'
        'attributes'    => 'user|groupusage|size|type|mode|ctime|atime|mtime'
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Search for files that begin with /home/example
my $search_files $cpliveapi->api2(
    'Fileman''search',
    {
        'dir'           => 'home/example'
        'attributes'    => 'user|groupusage|size|type|mode|ctime|atime|mtime'
    }  
 );

 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 search dir=home%2Fexample attributes=user%7Cgroupusage%7Csize%7Ctype%7Cmode%7Cctime%7Catime%7Cmtime

 

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "search",
    "data": [
      {
        "ctime": 1414597689,
        "mtime": 1414597689,
        "mode": 457,
        "file": "/home/example",
        "size": 4096,
        "mimeinfo": "homeb",
        "groupusage": 64768,
        "user": "example",
        "type": "dir",
        "atime": 1412105321
      },
      {
        "ctime": 1412105376,
        "mtime": 1412105376,
        "mode": 384,
        "file": "/home/example/.lastlogin",
        "size": 10,
        "mimeinfo": "text-x-generic",
        "groupusage": 64768,
        "user": "example",
        "type": "file",
        "atime": 1412105376
      },
      {
        "ctime": 1412233359,
        "mtime": 1412233359,
        "mode": 416,
        "file": "/home/example/cpbackup-exclude.conf",
        "size": 1,
        "mimeinfo": "text-plain",
        "groupusage": 64768,
        "user": "example",
        "type": "file",
        "atime": 1412233359
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}
  

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

 This parameter defaults to the home directory.

 Note:

 The function also searches this directory's subdirectories if therecursive value is 1.

 Any valid absolute file path.

 /home/user

 attributes

 string

 A list of attributes to return for each result.

 If you do not use this parameter, the function will not return any attributes.

  • user — Search for the file's owner's name.
  • groupusage — Search for the file's group's name.
  • size — Search for the file size.
  • type — Search for the file type.
  • mode — Search for the file's permissions.
  • ctime — Search for the file's creation time.
  • atime — Search for the last time that the file was accessed.
  • mtime — Search for the last time that the file was modified. 

 Note:

 Separate multiple attributes with the pipe character (|).

 user|size|type|mode|ctime

 recursive

 Boolean 

 Whether to perform the search recursively.

 This parameter defaults to 0.

  • 1 — Search recursively.
  • 0 — Do not search recursively.

 1

 mimeinfo

 Boolean

 Whether to return the mimeinforeturn.

 This parameter defaults to 1.

  • 1 — Return themimeinfo return for each result.
  • 0 — Do not return the mimeinfo return for each result.

 1

 regex

 string

 A Perl Compatible Regular Expression (PCRE) that filters the results.

 If you do not use this parameter, the function returns information for all of a directory's files. 

 A valid PCRE.

 user

   

   

Returns

Return

Type

Description

Possible values

Example

 atime

 integer

 The file's last accessed time.

 A Unix time stamp.

 1412105376

 ctime

 integer

 The file's creation time.

 A Unix time stamp.

 1413398577

 file

 string

 The file's name.

 A valid path and filename.

 /home/example/cpbackup-exclude.conf 

              

 groupusage 

 integer

 The file owner's system group ID.

 A positive integer.

 64768

 mimeinfo

 string

 The file's MIME type.

 A valid MIME type.

 text-plain

 mode

 integer

 The file's permissions.

 A set of file permissions, in decimal notation format. 

 493

 mtime

 integer

 The file's last modification time.

 A Unix time stamp.

 1413830456

 size

 integer

 The size of the file.

 A positive integer, in bytes.

 4096

 type

 string

 The item type.

  • file
  • dir
  • char
  • block
  • fifo
  • link
  • socket

 file

 user

 string

 The file owner's user ID.

 Any valid user ID on the server.

 example

 reason

 string

 A reason for failure

 Note:

 This function only returns a reasonvalue if an error occurred. 

 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

 

 
  • 11 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....