- 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 modifies a user's disk quota.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/editquota?api.version=1&user=user"a=500
https://hostname.example.com:2087/cpsess##########/xml-api/editquota?api.version=1&user=user"a=500
whmapi1 editquota user=user quota=500
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":"Set quota for user.", "output":{ "raw":"Using Universal Quota Support (quota=512000)\n" }, "result":1, "command":"editquota" } }
<result> <metadata> <version>1</version> <reason>Set quota for user.</reason> <output> <raw>Using Universal Quota Support (quota=512000)</raw> </output> <result>1</result> <command>editquota</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
user | string | Required The cPanel account username. | A valid cPanel username on the server. | user |
quota | string | Required The account's new quota. |
| 500 |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11+
Methods:
GET, POST
Required Parameters:
user
, quota
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 0 Functions - setresellermainip — This function assigns a main IP address to a reseller's account.
-
Page:WHM API 0 Functions - setresellernameservers — This function assigns nameservers to a reseller's account.
-
Page:WHM API 1 Sections - Accounts — Account functions allow you to manage cPanel accounts, WHM accounts, and their settings.
-
Page:WHM API 1 Functions - accountsummary — This function retrieves a summary of a user's account.
-
Page:WHM API 1 Functions - domainuserdata — This function retrieves domain data.