Child pages
  • cPanel API 1 Functions - FrontPage::fpstatus

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Note
titleNotes:
  • 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
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)None.
  • cPanel API 2Frontpage::fpenabled
    Excerpt Include
    cPanel API 2 Functions - Frontpage::fpenabled
    cPanel API 2 Functions - Frontpage::fpenabled
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_frontpage = $cpanel->api1('FrontPage','ftpstatus',array('example.com') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $check_frontpage = $cpliveapi->api1('FrontPage','ftpstatus',['example.com'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="FrontPage::ftpstatus($FORM('domain'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username FrontPage fpstatus domain=example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)
Code Block
languagexml
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.