cPanel module

Features

5 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="Features", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get_feature_metadata GET#

Return cPanel account's features' metadata

This function lists the details of a cPanel account's available feature lists.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

idstring

The feature's system ID.

is_plugininteger

Whether the feature is a plugin. 1 — Plugin. 0 — Not a plugin.

One of: 1 0

namestring

The feature's name.

has_feature GET#

Validate cPanel account's feature access

This function checks whether a cPanel account has access to a feature.

namestringRequired

The feature's name.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

has_features_like GET#

Return whether queried features are enabled

This function allows you to search for cPanel account features and determine whether those features are enabled.

patternstringRequired

The feature's name that you wish to search. Note: To use a regular expression, you must set the is_regex parameter's value to true.

is_regexintegerOptional

Whether the pattern parameter's value is a regular expression. 1 - The pattern parameter's value is a regular expression. 0 - The pattern parameter's value is not a regular expression

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

has_matching_featuresinteger

Whether any features match the search pattern and are enabled. 1 - At least one matching feature is enabled. 0 - No matching features are enabled (either no matches or all matches are disabled).

One of: 0 1

list_features GET#

Return cPanel account's features

This function lists a cPanel account's features.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Features available to the account. The key is a feature name and the value is whether the feature is installed. Note: This function returns features that third-party software or plugins provide.

list_features_like GET#

Return queried cPanel account features

This function allows you to search for enabled cPanel account features and lists those features in the returned payload.

patternstringRequired

The feature's name that you wish to search. Note: To use a regular expression, you must set the is_regex parameter's value to true.

is_regexintegerOptional

Whether the pattern parameter's value is a regular expression. 1 - The pattern parameter's value is a regular expression. 0 - The pattern parameter's value is not a regular expression

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

A list of enabled feature names that match the search pattern. Note: The function only returns enabled features.