cPanel API 2 Functions - Frontpage::fpenabled - Knowledgebase

Description

This function checks whether Microsoft® FrontPage® is enabled.

Warning:

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

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 willonly return 'not installed' or an error message.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Frontpage&cpanel_jsonapi_func=fpenabled&domain=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check whether FrontPage is enabled.
$check_fp_status = $cpanel->api2(
    'Frontpage', 'fpenabled',
        array(       
            'domain'      => 'example.com',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check whether FrontPage is enabled.
my $check_fp_status = $cpliveapi->api2(
    'Frontpage', 'fpenabled',
    {
            'domain'      => 'example.com',
    }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "fpenabled",
    "data": [
      {
        "fpenabled": 1,
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Frontpage"
  }
}

Note:

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

Parameters

Input	Type	Description	Possible values	Example
domain	string	Required The domain.	A valid domain on the cPanel account.	example.com

Input

Type

Description

Possible values

Example

domain

string

Required

The domain.

A valid domain on the cPanel account.

example.com

Returns

Return	Type	Description	Possible values	Example
fpenabled	boolean	Whether Frontpage is enabled.	1 — Enabled. 0 — Disabled.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue if there was an error.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories