Child pages
  • cPanel API 1 Functions - FrontPage::fpstatus
Skip to end of metadata
Go to start of metadata

Description

This function checks the domain's Microsoft® FrontPage® Extensions status.

Notes:

  • In cPanel & WHM version 11.44, if you uninstalled FrontPage extensions, or if FrontPage was never installed on the server, the server will ignore all FrontPage settings.
  • In cPanel & WHM version 11.46 and later, FrontPage extensions are no longer supported. These functions will only return 'not installed' or an error message.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_frontpage = $cpanel->api1('FrontPage','ftpstatus',array('example.com') ); // Call the function.


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.
my $check_frontpage = $cpliveapi->api1('FrontPage','ftpstatus',['example.com'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="FrontPage::ftpstatus($FORM('domain'))">
 Command Line
cpapi1 --user=username FrontPage fpstatus domain=example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
installed

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The domain name.

A valid domain name.example.com

Returns

  • installed — FrontPage is installed for the account.
  • not installed — FrontPage is not installed for the account.

In cPanel & WHM version 11.46 and later, this function returns 'not installed' or an error message.