Child pages
  • cPanel API 2 Functions - Fileman::getedittype
Skip to end of metadata
Go to start of metadata

Description

This function returns a file's type.


Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

In cPanel & WHM version 76 and later, when you disable the FileStorage role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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=getedittype&dir=home%2Fexample%2Fpublic_html%2Fnew_directory&file=example&editor=editarea


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.
 
// Search for a file's file type.
$getedittype = $cpanel->api2(
    'Fileman', 'getedittype', 
		array(
		'dir' 				=> 'new_directory'
		'file'				=> 'example'
    ) 
);


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.
 
# Search for a file's file type
my $getedittype = $cpliveapi->api2(
    'Fileman', 'getedittype',
	{
		'dir' 				=> 'new_directory'
		'file'				=> 'example'
	}	
 );


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 Fileman getedittype dir=new_directory file=example


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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": "getedittype",
    "data": [
      {
        "type": "html"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The file's path.

A valid absolute file path./home/user/public_html
filestring

Required

The filename.

A valid filename on the server.example

Returns

ReturnTypeDescriptionPossible valuesExample
typestringThe file's type.A valid file type.html
reasonstring

A reason for failure

Note:

This function only returns a reason value if an error occurred.

A string that describes the error.This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1