- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function edits RPM data. When you call this function, it performs the same actions as the following command:
/usr/local/cpanel/scripts/update_local_rpm_versions --edit section.key value
For more information, read our The rpm.versions System documentation.
Note:
After you call this function, we strongly recommend that you run the /usr/local/cpanel/scripts/check_cpanel_rpms
script.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/edit_rpm_version?api.version=1§ion=rpm_groups&key=3rdparty&value=cpanel-pcre
https://hostname.example.com:2087/cpsess##########/xml-api/edit_rpm_version?api.version=1§ion=rpm_groups&key=3rdparty&value=cpanel-pcre
whmapi1 edit_rpm_version section=rpm_groups key=3rdparty value=cpanel-pcre
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
{ "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "edit_rpm_version" }, "data": { "status": 1 } }
<result> <data> <status>1</status> </data> <metadata> <result>1</result> <version>1</version> <reason>OK</reason> <command>edit_rpm_version</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
section | string | Required The RPM's section. | A valid RPM section. | rpm_groups |
key | string | Required The RPM's key. | A valid RPM key. | 3rdparty |
value | string | Required The RPM's value. | A valid string. | cpanel-pcre |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
| Boolean | Whether the function succeeded. |
| 1 |
Function information
API Version:
Available in:
WHM 11.32+
Methods:
GET, POST
Required Parameters:
section
, key
, value
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - delete_rpm_version — This function removes RPM data.
-
Page:WHM API 1 Functions - edit_rpm_version — This function edits RPM data.
-
Page:WHM API 1 Functions - get_rpm_version_data — This function lists a key's available RPMs.
-
Page:WHM API 1 Functions - list_rpms — This function lists RPMs that the server needs, but the server owner has not yet installed.
-
Page:WHM API 1 Functions - package_manager_resolve_actions — This function resolves the state of a set of EasyApache 4 RPM packages.