cPanel API 2 Functions - Frontpage::list - Knowledgebase

Description

This function lists the Microsoft® FrontPage® status for each of the account's domains.

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=list

LiveAPI PHP Class

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List the FrontPage status for each of the account's domains.

my $list_fp_status = $cpliveapi->api2(

'Frontpage', 'list',

);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List the FrontPage status for each of the account's domains.
my $list_fp_status = $cpliveapi->api2(
    'Frontpage', 'list',
 );

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.

Command Line

Important:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "list",
    "data": [
      {
        "host": "example.com",
        "installaction": "Install Extensions",
        "root": "example.com",
        "shortstatus": "not",
        "status": "not installed",
        "uninstallaction": "Cleanup Old Extensions"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Frontpage"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
host	string	The domain name.	A valid domain on the cPanel account.	example.com
installaction	string	Text for the action to install FrontPage on the account.	Install Extensions — FrontPage is not currently installed. Reinstall Extensions — FrontPage is currently installed.	Install Extensions
root	string	The path to the account's FrontPage extensions.	A path on the server, relative to the user's home directory.	example.com
shortstatus	string	A short version of the domain's FrontPage status.	not — FrontPage is not currently installed. "" — FrontPage is currently installed.	not
status	string	The domain's FrontPage status.	installed — FrontPage is currently installed. not installed — FrontPage is not currently installed.	not installed
uninstallaction	string	Text for the action to uninstall FrontPage on the account.	Cleanup Old Extensions — FrontPage is not currently installed. Uninstall Extensions — FrontPage is currently installed.	Cleanup Old Extensions
reason	string	A reason for failure. Note: This function only returns areason value 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