- Created by Documentation, last modified on Oct 09, 2018
Backup:: fullbackup_to_ftp
Backup:: fullbackup_to_homedir
Backup:: fullbackup_to_scp_with_key
Backup:: fullbackup_to_scp_with_password
Backup:: list_backups
Batch:: strict
Brand:: read
Branding:: file
Branding:: get_applications
Branding:: get_application_information
Branding:: get_available_applications
Branding:: get_information_for_applications
Branding:: image
Branding:: include
Branding:: spritelist
Chkservd:: get_exim_ports
Chkservd:: get_exim_ports_ssl
Chrome:: get_dom
Contactus:: is_enabled
cPGreyList:: disable_all_domains
cPGreyList:: disable_domains
cPGreyList:: enable_all_domains
cPGreyList:: enable_domains
cPGreyList:: has_greylisting_enabled
cPGreyList:: list_domains
DomainInfo:: domains_data
DomainInfo:: list_domains
DomainInfo:: main_domain_builtin_subdomain_aliases
DomainInfo:: single_domain_data
DNSSEC:: disable_dnssec
DNSSEC:: enable_dnssec
DNSSEC:: fetch_ds_records
DNSSEC:: set_nsec3
DNSSEC:: unset_nsec3
Email:: account_name
Email:: add_auto_responder
Email:: add_domain_forwarder
Email:: add_forwarder
Email:: add_list
Email:: add_mailman_delegates
Email:: add_mx
Email:: add_pop
Email:: add_spam_filter
Email:: browse_mailbox
Email:: change_mx
Email:: check_fastmail
Email:: check_pipe_forwarder
Email:: delete_auto_responder
Email:: delete_domain_forwarder
Email:: delete_filter
Email:: delete_forwarder
Email:: delete_held_messages
Email:: delete_list
Email:: delete_mx
Email:: delete_pop
Email:: disable_filter
Email:: disable_mailbox_autocreate
Email:: disable_spam_assassin
Email:: disable_spam_autodelete
Email:: disable_spam_box
Email:: dispatch_client_settings
Email:: edit_pop_quota
Email:: enable_filter
Email:: enable_mailbox_autocreate
Email:: enable_spam_assassin
Email:: enable_spam_box
Email:: fetch_charmaps
Email:: fts_rescan_mailbox
Email:: generate_mailman_otp
Email:: get_auto_responder
Email:: get_charsets
Email:: get_client_settings
Email:: get_default_email_quota
Email:: get_default_email_quota_mib
Email:: get_disk_usage
Email:: get_filter
Email:: get_held_message_count
Email:: get_mailbox_autocreate
Email:: get_mailman_delegates
Email:: get_main_account_disk_usage
Email:: get_main_account_disk_usage_bytes
Email:: get_max_email_quota
Email:: get_max_email_quota_mib
Email:: get_pop_quota
Email:: get_spam_settings
Email:: get_webmail_settings
Email:: has_delegated_mailman_lists
Email:: has_plaintext_authentication
Email:: hold_outgoing
Email:: is_integer
Email:: list_auto_responders
Email:: list_default_address
Email:: list_domain_forwarders
Email:: list_filters
Email:: list_filters_backups
Email:: list_forwarders
Email:: list_forwarders_backups
Email:: list_lists
Email:: list_mail_domains
Email:: list_mxs
Email:: list_pops
Email:: list_pops_with_disk
Email:: list_system_filter_info
Email:: passwd_list
Email:: passwd_pop
Email:: release_outgoing
Email:: remove_mailman_delegates
Email:: reorder_filters
Email:: set_always_accept
Email:: set_default_address
Email:: set_list_privacy_options
Email:: stats_db_status
Email:: store_filter
Email:: suspend_incoming
Email:: suspend_login
Email:: suspend_outgoing
Email:: trace_filter
Email:: unsuspend_incoming
Email:: unsuspend_login
Email:: unsuspend_outgoing
Email:: verify_password
EmailAuth:: disable_dkim
EmailAuth:: enable_dkim
EmailAuth:: ensure_dkim_keys_exist
EmailAuth:: fetch_dkim_private_keys
EmailAuth:: install_dkim_private_keys
EmailAuth:: install_spf_records
EmailAuth:: validate_current_dkims
EmailAuth:: validate_current_ptrs
EmailAuth:: validate_current_spfs
ExternalAuthentication:: add_authn_link
ExternalAuthentication:: configured_modules
ExternalAuthentication:: get_authn_links
ExternalAuthentication:: has_external_auth_modules_configured
ExternalAuthentication:: remove_authn_link
Features:: has_feature
Features:: list_features
Fileman:: autocompletedir
Fileman:: empty_trash
Fileman:: get_file_content
Fileman:: get_file_information
Fileman:: list_files
Fileman:: save_file_content
Fileman:: transcode
Fileman:: upload_files
Ftp:: add_ftp
Ftp:: allows_anonymous_ftp
Ftp:: allows_anonymous_ftp_incoming
Ftp:: delete_ftp
Ftp:: ftp_exists
Ftp:: get_ftp_daemon_info
Ftp:: get_port
Ftp:: get_quota
Ftp:: get_welcome_message
Ftp:: kill_session
Ftp:: list_ftp
Ftp:: list_ftp_with_disk
Ftp:: list_sessions
Ftp:: passwd
Ftp:: server_name
Ftp:: set_anonymous_ftp
Ftp:: set_anonymous_ftp_incoming
Ftp:: set_homedir
Ftp:: set_quota
Ftp:: set_welcome_message
Integration:: fetch_url
LangPHP:: php_get_domain_handler
LangPHP:: php_get_impacted_domains
LangPHP:: php_get_installed_versions
LangPHP:: php_get_system_default_version
LangPHP:: php_get_vhost_versions
LangPHP:: php_ini_get_user_basic_directives
LangPHP:: php_ini_get_user_content
LangPHP:: php_ini_get_user_paths
LangPHP:: php_ini_set_user_basic_directives
LangPHP:: php_ini_set_user_content
LangPHP:: php_set_vhost_versions
LastLogin:: get_last_or_current_logged_in_ip
Locale:: get_attributes
Mailboxes:: expunge_mailbox_messages
Mailboxes:: expunge_messages_for_mailbox_guid
Mailboxes:: get_mailbox_status
Mailboxes:: has_utf8_mailbox_names
Mailboxes:: set_utf8_mailbox_names
Market:: cancel_pending_ssl_certificate
Market:: create_shopping_cart
Market:: get_all_products
Market:: get_certificate_status_details
Market:: get_login_url
Market:: get_pending_ssl_certificates
Market:: get_provider_specific_dcv_constraints
Market:: get_providers_list
Market:: get_ssl_certificate_if_available
Market:: process_ssl_pending_queue
Market:: request_ssl_certificates
Market:: set_status_of_pending_queue_items
Market:: set_url_after_checkout
Market:: validate_login_token
Mime:: add_handler
Mime:: add_hotlink
Mime:: add_mime
Mime:: add_redirect
Mime:: delete_handler
Mime:: delete_hotlink
Mime:: delete_mime
Mime:: delete_redirect
Mime:: list_handlers
Mime:: list_hotlinks
Mime:: list_mime
Mime:: list_redirects
Mime:: redirect_info
ModSecurity:: disable_all_domains
ModSecurity:: disable_domains
ModSecurity:: enable_all_domains
ModSecurity:: enable_domains
ModSecurity:: has_modsecurity_installed
ModSecurity:: list_domains
Mysql:: add_host
Mysql:: add_host_note
Mysql :: check_database
Mysql:: create_database
Mysql:: create_user
Mysql:: delete_database
Mysql:: delete_host
Mysql:: delete_user
Mysql:: get_host_notes
Mysql:: get_privileges_on_database
Mysql:: get_restrictions
Mysql:: get_server_information
Mysql:: locate_server
Mysql:: rename_database
Mysql:: rename_user
Mysql:: repair_database
Mysql:: revoke_access_to_database
Mysql:: set_password
Mysql:: set_privileges_on_database
Notifications:: get_notifications_count
Parser:: firstfile_relative_uri
PassengerApps:: disable_application
PassengerApps:: edit_application
PassengerApps:: enable_application
PassengerApps:: list_applications
PassengerApps:: register_application
PassengerApps:: unregister_application
PasswdStrength:: get_required_strength
Postgresql:: create_database
Postgresql:: create_user
Postgresql:: delete_database
Postgresql:: get_restrictions
Postgresql:: grant_all_privileges
Postgresql:: rename_database
Postgresql:: rename_user
Postgresql:: rename_user_no_password
Postgresql:: revoke_all_privileges
Postgresql:: set_password
Pushbullet:: send_test_message
Quota:: get_quota_info
Resellers:: list_accounts
ResourceUsage:: get_usages
Session:: create_temp_user
SpamAssassin :: clear_spam_box
SpamAssassin:: get_symbolic_test_names
SpamAssassin:: get_user_preferences
SpamAssassin:: update_user_preference
SSH:: get_port
SSL:: add_autossl_excluded_domains
SSL:: check_shared_cert
SSL:: delete_cert
SSL:: delete_csr
SSL:: delete_key
SSL:: delete_ssl
SSL :: disable_mail_sni
SSL:: enable_mail_sni
SSL:: fetch_best_for_domain
SSL:: fetch_cert_info
SSL:: fetch_certificates_for_fqdns
SSL:: fetch_key_and_cabundle_for_certificate
SSL:: find_certificates_for_key
SSL:: find_csrs_for_key
SSL:: generate_cert
SSL:: generate_csr
SSL:: generate_key
SSL:: get_autossl_excluded_domains
SSL:: get_autossl_pending_queue
SSL:: get_autossl_problems
SSL:: get_cabundle
SSL:: get_cn_name
SSL:: install_ssl
SSL:: installed_host
SSL:: installed_hosts
SSL:: is_autossl_check_in_progress
SSL:: is_mail_sni_supported
SSL:: is_sni_supported
SSL:: list_certs
SSL:: list_csrs
SSL:: list_keys
SSL:: list_ssl_items
SSL:: mail_sni_status
SSL:: rebuild_mail_sni_config
SSL:: rebuildssldb
SSL:: remove_autossl_excluded_domains
SSL:: set_autossl_excluded_domains
SSL:: set_cert_friendly_name
SSL:: set_csr_friendly_name
SSL:: set_key_friendly_name
SSL:: set_primary_ssl
SSL:: set_ssl_share
SSL:: show_cert
SSL:: show_csr
SSL:: show_key
SSL:: start_autossl_check
SSL:: upload_cert
SSL:: upload_key
StatsBar:: get_stats
SubDomain:: addsubdomain
TwoFactorAuth:: generate_user_configuration
TwoFactorAuth:: get_user_configuration
TwoFactorAuth:: remove_user_configuration
TwoFactorAuth:: set_user_configuration
UserManager:: check_account_conflicts
UserManager:: create_user
UserManager:: delete_user
UserManager:: dismiss_user
UserManager:: edit_user
UserManager:: list_users
UserManager:: lookup_service_account
UserManager:: lookup_user
UserManager:: merge_service_account
UserManager:: unlink_service_account
WebmailApps:: listwebmailapps
WebVhost:: list_domains
WebVhost:: list_ssl_capable_domains
WordPressBackup:: any_running
WordPressBackup:: cancel
WordPressBackup:: cleanup
WordPressBackup:: get_available_backups
WordPressBackup:: is_running
WordPressBackup:: start
WordPressInstanceManager:: cancel_scan
WordPressInstanceManager:: cleanup_scan
WordPressInstanceManager:: change_admin_password
WordPressInstanceManager:: configure_autoupdate
WordPressInstanceManager:: get_api_version
WordPressInstanceManager:: get_instance_by_id
WordPressInstanceManager:: get_instances
WordPressInstanceManager:: get_latest_wordpress_version_from_wordpress_org
WordPressInstanceManager:: get_scan_results
WordPressInstanceManager:: is_installable_addon_available
WordPressInstanceManager:: start_scan
Description
This function returns a sorted list of files and directories.
Important:
FileStorage
role, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2083/cpsess##########/execute/Fileman/list_files?dir=public_html&types=dir%7Cfile&limit_to_list=0&show%20hidden=1&check_for_leaf_directories=1&include_mime=1&include_hash=1&include_permissions=0
Note:
This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation.
$cpanel = new CPANEL(); // Connect to cPanel - only do this once. // List files and directories for example.com. $list_files = $cpanel->uapi( 'Fileman', 'list_files', array( 'dir' => 'public_html', 'types' => 'dir|file', 'limit_to_list' => '0', 'show_hidden' => '1', 'check_for_leaf_directories' => '1', 'include_mime' => '1', 'include_hash' => '0', 'include_permissions' => '0', ) );
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # List files and directories for example.com my $ list_files = $cpliveapi->uapi( 'Fileman', 'list_files', { 'dir' => 'public_html', 'types' => 'dir|file', 'limit_to_list' => '0', 'show_hidden' => '1', 'check_for_leaf_directories' => '1', 'include_mime' => '1', 'include_hash' => '0', 'include_permissions' => '0', } );
<!-- Get a hash of all the data, then display the file value. --> [% data = execute( 'Fileman', 'list_files' {'dir' => public_html', 'types' => 'dir|file', limit_to_list' => '0', 'show_hidden' => '1', 'check_for_leaf_directories' => '1', 'include_mime' => '1', 'include_hash' => '0', 'include_permissions' => '0',} ); %] [% FOREACH q = data.file %] <p> [% q %] </p> [% END %] <!-- Get only a hash of the data. --> [% execute('Fileman', 'list_files' {'dir' => 'public_html', 'types' => 'dir|file', limit_to_list' => '0', 'show_hidden' => '1', 'check_for_leaf_directories' => '1', 'include_mime' => '1', 'include_hash' => '0', 'include_permissions' => '0',} ).data.file %]
uapi --user=username Fileman list_files dir=public_html types=dir%7Cfile limit_to_list=0 show_hidden=1 check_for_leaf_directories=1 include_mime=1 include_hash=1 include_permissions=0
Notes:
- You must URI-encode values.
username
represents your account-level username.- For more information and additional output options, read our Guide to UAPI documentation or run the
uapi --help
command. If you run CloudLinux™, you must use the full path of the
uapi
command:/usr/local/cpanel/bin/uapi
{ "messages": null, "errors": null, "status": 1, "data": { "files": [ { "ctime": 1371711650, "uid": 508, "mode": 33184, "mtime": 1371711650, "file": "cpbackup-exclude.conf", "path": "/home/example", "nicemode": "0640", "humansize": "1 byte", "size": "1", "fullpath": "/home/example/cpbackup-exclude.conf", "absdir": "/home/example", "type": "file", "exists": 1, "gid": 508 } ], "dirs": [ { "ctime": 1377179101, "uid": "", "mode": 16872, "mtime": 1371591601, "file": "access-logs", "path": "/home/example", "nicemode": "0750", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/access-logs", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1371752441, "uid": 508, "mode": 16877, "mtime": 1371752441, "file": "cpanel3-skel", "path": "/home/example", "nicemode": "0755", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/cpanel3-skel", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1372270682, "uid": 508, "mode": 16872, "mtime": 1372270682, "file": "etc", "path": "/home/example", "nicemode": "0750", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/etc", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 12 }, { "ctime": 1372192801, "uid": 508, "mode": 16873, "mtime": 1372192801, "file": "mail", "path": "/home/example", "nicemode": "0751", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/mail", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1371590824, "uid": 508, "mode": 16872, "mtime": 1371590824, "file": "public_ftp", "path": "/home/example", "nicemode": "0750", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/public_ftp", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1377196555, "uid": 508, "mode": 16872, "mtime": 1377196555, "file": "public_html", "path": "/home/example", "nicemode": "0750", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/public_html", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 99 }, { "ctime": 1371711650, "uid": 508, "mode": 16877, "mtime": 1371711650, "file": "ssl", "path": "/home/example", "nicemode": "0755", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/ssl", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1377111650, "uid": 508, "mode": 16877, "mtime": 1377111650, "file": "tmp", "path": "/home/example", "nicemode": "0755", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/tmp", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 508 }, { "ctime": 1377196555, "uid": 508, "mode": 16872, "mtime": 1377196555, "file": "www", "path": "/home/example", "nicemode": "0750", "humansize": "4 KB", "size": "4096", "fullpath": "/home/example/www", "absdir": "/home/example", "type": "dir", "exists": 1, "gid": 99 } ] } }
Note:
Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
Parameters | Type | Description | Possible values | Example |
---|---|---|---|---|
dirs | string | Required The directory from which to list files. | A valid directory on the server. | public_html |
| string | A pipe-separated list of file types to return. If you do not use this parameter, the function returns all file types. |
| file|dir |
| Boolean | Whether to return only entries that begin with If you do not use this parameter, the function returns all filenames.
|
| 0 |
| string | The files to return. If you do not use this parameter, the function returns all files.
| A list of comma-separated files. | cpbackup-exclude.conf |
| Boolean | Whether to include hidden files in the output. This parameter defaults to
|
| 1 |
| Boolean | Whether to return directories that contain subdirectories. This parameter defaults to |
| 1 |
| string | The MIME types to return. If you use this parameter, the function returns the specified MIME types and sets the If you do not use this parameter, the function returns all MIME types. | A comma-separated list of MIME types. | text-plain |
| string | The raw MIME types to return. If you use this parameter, the function returns the specified MIME types and sets the If you do not use this parameter, the function returns all MIME types.
| A comma-separated list of raw MIME types. | text/plain |
| Boolean | Whether to return the file's MIME type. This parameter defaults to Note: If you set this value to |
| 1 |
| Boolean | Whether to include a hash of the file's information in the return. This parameter defaults to
|
| 0 |
| Boolean | Whether to parse the file owner's read and write permissions. This parameter defaults to |
| 0 |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
files | array of hashes | An array of hashes that contains information about each file. | This array of hashes includes the absdir , ctime , exists , file , fullpath , gid , hash , humansize , isleaf , mimename , mimetype , mode , mtime , nicemode , path , phash , rawmimename , rawmimetype , size , type , uid , read , write , and isparent returns. | |
| string | The path to the user's home directory. The function returns this value in the | A valid file path. | /home/user |
| string | The file's creation time. The function returns this value in the | A time in Unix time format. |
1400573272
|
| Boolean | Whether the file exists in the directory. The function returns this value in the |
| 1 |
| string | The filename. The function returns this value in the | A valid filename on the server. | cgi-bin |
| string | The file's full file path. The function returns this value in the | A valid filepath on the server. | /home/user/public_html/cgi-bin |
| integer | The file owner's system group ID. The function returns this value in the | A positive integer. | 503 |
| string | The full file path's hash. The function returns this value in the | A string of letters and integers. | L2hvbWUvY29saW4vcHVibGljX2h0bWw |
| string | The formatted size of the file. The function returns this value in the | A positive integer and one of the following symbols:
| 5 KB |
| Boolean | Whether the directory contains subdirectories. The function returns this value in the |
| 1 |
| string | The file's MIME type name. The function returns this value in the | A valid MIME name on the server. | text-plain |
| string | The file's MIME type. The function returns this value in the | A valid MIME type on the server. | text/plain |
| string | The file's textual permissions. The function returns this value in the | A string value in Unix format . |
16877
|
| string | The file's last modification time. The function returns this value in the | A time in Unix time format. |
1400573272
|
| integer | The file's numerical permissions. The function returns this value in the | An integer value in octal notation . | 0755 |
| string | The absolute path to the file. The function returns this value in the | A valid file path. | /home/user/public.html |
| string | The parent filepath's file hash. The function returns this value in the | A string of letters and integers. | L2hvbWUvY29saW4vcHVibGljX2h0bWw |
| string | The file's raw MIME type's name. The function returns this value in the | A valid raw MIME type's name on the server. | text-plain |
| string | The file's raw MIME type. The function returns this value in the | A valid raw MIME type on the server. | text/plain |
| integer | The file's size, in bytes. The function returns this value in the | A positive integer. | 4096 |
| string | The item's type. The function returns this value in the |
| file |
| integer | The file owner's system user ID. The function returns this value in the | A positive integer. | 502 |
| Boolean | Whether the file is readable. Note: The function only returns this value if the The function returns this value in the |
| 1 |
| Boolean | Whether the file is writable. Note: The function only returns this value if the The function returns this value in the |
| 1 |
| Boolean | Whether the file is a parent record. The function returns this value in the |
| 1 |
dirs | array of hashes | An array of hashes that contains information about each directory. | This array of hashes includes the absdir , ctime , exists , file , fullpath , gid , hash , humansize , isleaf , mimename , mimetype , mode , mtime , nicemode , path , phash , rawmimename , rawmimetype , size , type , uid , read , write , and isparent returns. | |
| string | The path to the user's home directory. The function returns this value in the | A valid file path. | /home/user |
| string | The directory's creation time. The function returns this value in the | A time in Unix time format. | 1400573272 |
| Boolean | Whether the directory exists in the directory. The function returns this value in the |
| 1 |
| string | The directory name. The function returns this value in the | A valid directory name on the server. | cgi-bin |
| string | The directory's full directory path. The function returns this value in the | A valid directory path on the server. | /home/user/public_html/cgi-bin |
| integer | The directory owner's system group ID. The function returns this value in the | A positive integer. | 503 |
| string | The full directory path's hash. The function returns this value in the | A string of letters and integers. | L2hvbWUvY29saW4vcHVibGljX2h0bWw |
| string | The formatted size of the directory. The function returns this value in the | A positive integer and one of the following symbols:
| 5 KB |
| Boolean | Whether the directory contains subdirectories. The function returns this value in the |
| 1 |
| string | The MIME type's name. The function returns this value in the | A valid MIME name on the server. | text-plain |
| string | The directory's MIME's type. The function returns this value in the | A valid MIME type on the server. | text/plain |
| string | The directory's textual permissions. The function returns this value in the | A string value in Unix format. |
16877
|
| string | The directory's last modification time. The function returns this value in the | A time in Unix time format. | 1400573272 |
| integer | The directory's numerical permissions. The function returns this value in the | An integer value in octal notation. | 0755 |
| string | The path to the directory. The function returns this value in the | A valid file path. | /home/user/public.html |
| string | The parent directory path's hash. The function returns this value in the | A string of letters and integers. | L2hvbWUvY29saW4vcHVibGljX2h0bWw |
| string | The directory's raw MIME type's name. The function returns this value in the | A valid raw MIME type name on the server. | text-plain |
| string | The directory's raw MIME type. The function returns this value in the | A valid raw MIME type on the server. | text/plain |
| integer | The directory's size, in bytes. The function returns this value in the | A positive integer. | 4096 |
| string | The item's type. The function returns this value in the |
| file |
| integer | The directory owner's system user ID. The function returns this value in the | A positive integer. | 502 |
| Boolean | Whether the directory is readable. Note: The function only returns this value if the The function returns this value in the |
| 1 |
| Boolean | Whether the directory is writable. Note: The function only returns this value if the The function returns this value in the |
| 1 |
| Boolean | Whether the directory is a parent record. The function returns this value in the |
| 1 |
Function information
Module:
Fileman
API Version:
Available in:
cPanel 11.44+
Methods:
GET, POST
Required Parameters:
dir
Return Formats:
JSON, XML
Legacy Equivalents:
About this module
The Fileman
module provides access to file functions.
About UAPI
UAPI accesses and modifies data for cPanel accounts.
Notes:
- These functions may require specific features. To enable or disable features, use WHM's Feature Manager interface.
- Unless you call this API via the WHM API, you must use the appropriate cPanel ports (
2082
or2083
). You can also call some functions via cPanel's Webmail ports (2095
or2096
).
Find a function
Related functions
-
Page:UAPI Modules - Fileman — The
Fileman
module provides access to file functions. -
Page:UAPI Functions - Fileman::autocompletedir — This function returns any files and directories that begin with a specified string.
-
Page:UAPI Functions - Fileman::empty_trash — This function purges content from the
.trash
folder in the user's home directory. -
Page:UAPI Functions - Fileman::get_file_content — This function retrieves a file's content.
-
Page:UAPI Functions - Fileman::get_file_information — This function returns the information for a specified file or directory.