Child pages
  • cPanel API 2 Functions - Frontpage::list
Skip to end of metadata
Go to start of metadata

 

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 will only 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


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the FrontPage status for each of the account's domains.
$list_fp_status = $cpanel->api2(
    'Frontpage', 'list'
 );


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.
 
# List the FrontPage status for each of the account's domains.
my $list_fp_status = $cpliveapi->api2(
    'Frontpage', 'list',
 );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
hoststringThe domain name.

A valid domain on the cPanel account.

example.com
installactionstringText for the action to install FrontPage on the account.
  • Install Extensions — FrontPage is not currently installed.
  • Reinstall Extensions — FrontPage is currently installed.
Install Extensions
rootstringThe path to the account's FrontPage extensions.A path on the server, relative to the user's home directory.example.com
shortstatusstringA short version of the domain's FrontPage status.
  • not — FrontPage is not currently installed.
  • "" — FrontPage is currently installed.
not
statusstringThe domain's FrontPage status.
  • installed — FrontPage is currently installed.
  • not installed — FrontPage is not currently installed.
not installed
uninstallactionstringText 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
reasonstring

A reason for failure.

Note:

This function only returns a reason value if there was an error.

A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1