Developer Documentation
Child pages
  • WHM API 1 Functions - editquota
Skip to end of metadata
Go to start of metadata

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function modifies a user's disk quota.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/editquota?api.version=1&user=user&quota=500
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/editquota?api.version=1&user=user&quota=500
 Command Line
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

 Output (JSON)
{  
   "metadata":{  
      "version":1,
      "reason":"Set quota for user.",
      "output":{  
         "raw":"Using Universal Quota Support (quota=512000)\n"
      },
      "result":1,
      "command":"editquota"
   }
}
 Output (XML)
<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:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account username.

A valid cPanel username on the server.user
quotastring

Required

The account's new quota.

  • A positive integer that represents the maximum amount of disk space, in Megabytes (MB).
  • 0 or unlimited grants the account unlimited disk space.
500

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

user, quota

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

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 or 2087) to call WHM API functions.
  

Find a function

Related functions