Child pages
  • WHM API 1 Functions - remove_override_features_for_user
Skip to end of metadata
Go to start of metadata

 

Description

This function removes feature overrides from a cPanel account.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remove_override_features_for_user?api.version=1&user=overridepriv&features=%5B%22sslinstall%22%2C%22videotut%22%5D
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remove_override_features_for_user?api.version=1&user=overridepriv&features=%5B%22sslinstall%22%2C%22videotut%22%5D
 Command Line
whmapi1 remove_override_features_for_user user=username features=%5B%22sslinstall%22%2C%22videotut%22%5D


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "command":"remove_override_features_for_user",
      "version":1,
      "reason":"OK",
      "result":1
   }
}
 Output (XML)
<result>
    <metadata>
        <result>1</result>
        <version>1</version>
        <reason>OK</reason>
        <command>remove_override_features_for_user</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample

user

string

Required

The user's username.

A valid cPanel username.username
featuresarray

Required

The features' names.


 

An array that lists the features' names.

Note:

Call WHM API 1's get_feature_names function to view available features.

["sslinstall","videotut"]

Returns

This function only returns metadata.