CPcpanel
Meridian

Return account's available post-login landings

Changed on

This function lists the post_login_landing values that a cPanel account can use. Pass one of these values to the create_user_session function's post_login_landing parameter to open the new session at that landing, such as a website builder. A landing does not require the create_user_session function's website parameter.

If the Meridian theme's landing manifest is missing or invalid, the function still succeeds and logs a warning to the /usr/local/cpanel/logs/error_log file.

Note:

  • You can call this function for any cPanel account for which you can call the create_user_session function: root can call it for any cPanel account, and a reseller can call it for the accounts that it owns and for its own account.
  • This function is only available over SSL connections.
get/list_post_login_landings

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

userstring required
Example:username

The cPanel account username or a valid email address of a login that belongs to the account, to list landings for. If this parameter's value is not the account's system user, such as a team user, every landing type in the available return field is an empty array.

The function fails if the account does not exist or is suspended, or if you cannot call the create_user_session function for it.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "available": {
      "website_builders": [
        {
          "id": "sitejet"
        },
        {
          "id": "nova"
        }
      ]
    }
  },
  "metadata": {
    "command": "list_post_login_landings",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes