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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Description

This function adds Microsoft® FrontPage® Extensions to the domain.

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. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$add_frontpage = $cpanel->api1('FrontPage', 'addfp', array('example.com','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 $add_frontpage = $cpliveapi->api1('FrontPage', 'addfp', ['example.com','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::addfp( $FORM('ftpdomain','psuedodomain') )">
 Command Line
cpapi1 --user=username FrontPage addfp ftpdomain=example.com pseudodomain=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)
Saving .htaccess file: /home/example/public_html/.htaccess
Using Upgrade Mode
Saving .htaccess file: /home/example/public_html/_private/.htaccess
Saving .htaccess file: /home/example/public_html/secondary.com/.htaccess
Saving .htaccess file: /home/example/public_html/secondary.com/_private/.htaccess
Saving .htaccess file: /home/example/public_html/tertiary.com/.htaccess
Starting install, port: 80.
Created: 01 Feb 2014 02:43:18 -0000
Version: 5.0.2.4803
Server extensions already installed on port 80.
Reverting to upgrade.
Starting upgrade, port: 80.
Created: 01 Feb 2014 02:43:18 -0000
Version: 5.0.2.4803
Port 80: Upgrade completed.
Upgraded Version: 5.0.2.4803.
Merging .htaccess file: /home/example/public_html/.htaccess
Merging .htaccess file: /home/example/public_html/_private/.htaccess
Merging .htaccess file: /home/example/public_html/secondary.com/.htaccess
Merging .htaccess file: /home/example/public_html/secondary.com/_private/.htaccess
Merging .htaccess file: /home/example/public_html/tertiary.com/.htaccess
Setting Password
Frontpage passthough auth enabled in /home/example/public_html!
Frontpage was installed on the following domains: example.com

   

Parameters

ParameterTypeDescriptionPossible valuesExample
ftpdomain

string

Required

The domain name.

A valid domain name.example.com
psuedodomainstring

Required

The domain name.

A valid domain name.example.com

Returns

This function returns a set of FrontPage status information.

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

  • No labels