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

Description

This function edits a hosting plan (package).

Note:

This function cannot modify package names. 

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/editpkg?api.version=1&name=package1&featurelist=default&quota=unlimited
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/editpkg?api.version=1&name=package1&featurelist=default&quota=unlimited
 Command Line
whmapi1 editpkg name=package1 featurelist=default quota=unlimited


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)
{
  "data": {
    "changepackage": [
       
    ],
    "pkg": "newpackage1"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "editpkg"
  }
}
 Output (XML)
<result>
    <data>
        <pkg>newpackage1</pkg>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>editpkg</command>
    </metadata>
</result>


Note:

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

Parameters

Note:

The Access Control List (ACL) restricts some of the following parameters, which limit the features that WHM users can access. For more information, read our Access Control Lists documentation.


ParameterTypeDescriptionPossible valuesExample
namestring

Required

The hosting plan's name.

An existing hosting plan name on the server.

package1
featureliststring

The hosting plan's feature list.

If you do not use this parameter, the function assigns the default feature list to the hosting plan's accounts.

A valid feature list name on the server.feature_list
quotastring

The hosting plan's disk space quota.

Note:

In cPanel & WHM version 70 and earlier, this parameter defaults to unlimited.

This parameter defaults to 10240.

  • A positive integer between one and 999,999 that represents the maximum disk space that the account may use, in Megabytes (MB).
  • 0, unlimited, or null — The hosting plan's disk space is unlimited.

    Note:

    The 0, unlimited, or null values are only available to users that possess the corresponding unlimited ACL permission.

10240
ipstring

Whether the account has a dedicated IP address.

This parameter defaults to n.

  • y — The account possesses a dedicated IP address.
  • n — The account does not possess a dedicated IP address.
n
cgiBoolean

Whether CGI access is enabled for the account.

This parameter defaults to 1.

  • 1 — Enabled.
  • 0 — Disabled.
1
frontpageBoolean

Whether Microsoft® FrontPage Extensions are enabled for the account.

Note:

cPanel & WHM will ignore all FrontPage settings and parameters if either of the following statements is true:

  • The server runs cPanel & WHM version 11.44 and FrontPage Extensions are not installed.
  • The server runs cPanel & WHM version 11.46 or later.
  • 1 — Enabled.
  • 0 — Disabled.
0
cpmodstring

The hosting plan's cPanel theme.

This parameter defaults to the server's default cPanel theme.

  • paper_lantern
  • A valid theme on the server.
paper_lantern
languagestring

The hosting plan's default locale.

This parameter defaults to the server's default locale.

A two-letter ISO-3166 code. en
max_emailacct_quotastring

The hosting plan's maximum email account quota size.

Notes:

  • This parameter does not affect any existing email accounts.
  • We introduced this parameter in cPanel & WHM version 70.

This parameter defaults to 1024.

  • A positive integer between one and 4,294,967,296 that represents the maximum email quota size, in MB.
  • unlimited — The account possesses an unlimited quota.

    Note:

    The 0, unlimited, or null values are only available to users that possess the corresponding unlimited ACL permission.

1024
maxftp string

The hosting plan's maximum number of FTP accounts.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited FTP accounts.
unlimited
maxsql string

The hosting plan's maximum number of each available type of SQL database.

For example, if you set this value to 5 and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited databases.
unlimited
maxpop string

The hosting plan's maximum number of email accounts.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited email accounts.
unlimited
maxlists string

The hosting plan's maximum number of mailing lists.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited mailing lists.
unlimited
maxsub string

The hosting plan's maximum number of subdomains.

This parameter defaults to unlimited.

  • A positive integer between one and 999,999.
  • 0, unlimited, or null — The account possesses unlimited subdomains.
unlimited
maxpark string

The hosting plan's maximum number of parked domains (aliases).

This parameter defaults to 0.

  • An integer between zero and 999,999.
  • unlimited or null — The account possesses unlimited parked domains.
unlimited
maxaddon string

The hosting plan's maximum number of addon domains.

This parameter defaults to 0.

  • An integer between zero and 999,999.
  • unlimited or null — The account possess unlimited addon domains.
unlimited
hasshellBoolean

Whether the account has shell access.

This parameter defaults to 0.

  • 1 — The account has shell access.
  • 0 — No shell access.
1
bwlimit string

The hosting plan's maximum bandwidth use.

Note:

In cPanel & WHM version 70 and earlier, this parameter defaults to unlimited.

This parameter defaults to 1048576.

  • A positive integer between one and 999,999 that represents the maximum bandwidth use, in Megabytes (MB).
  • 0, unlimited, or null — The account possesses unlimited bandwidth.

    Note:

    The 0, unlimited, or null values are only available to users that possess the corresponding unlimited ACL permission.

1048576
max_email_per_hour string

The maximum number of emails that the account can send in one hour.

This parameter defaults to unlimited.

Note:

This parameter is only available in cPanel & WHM version 11.32 or later. 

  • A positive integer.
  • 0 or unlimited — The account can send an unlimited number of emails.

unlimited
max_defer_fail_percentage string

The percentage of failed or deferred email messages that the account can send per hour before outgoing mail is rate-limited.

Note:

This parameter is only available in cPanel & WHM version 11.32 or later. 

  • A positive integer.
  • 0 or unlimited — The account can send an unlimited number of failed or deferred messages.
unlimited
digestauthBoolean

Whether to enable Digest Authentication for accounts on the hosting plan.

Note:

This parameter is only available in cPanel & WHM version 11.34 or later.

This parameter defaults to 0.

  • 1 — Enable.
  • 0 — Disable.
1
_PACKAGE_EXTENSIONSstring

The hosting plan's package extensions.

If you do not provide a value, the hosting plan will not include package extensions.

Notes:

  • This parameter is only available in cPanel & WHM version 11.40 and later.
  • In cPanel & WHM 68 and later, we strongly recommend that you manage package extensions through WHM API 1's addpkgext and delpkgext functions.

A space-delimited list of one or more package extensions on the server.

Notes:

  • You can also include the extension's variables in your function call, in key=value format. Consult the extension's documentation for a list of possible variables.
  • Extension names and variables are case-sensitive.
extension1 extension2 extension3

Returns

ReturnTypeDescriptionPossible valuesExample

pkg

string

The hosting plan's name.

The name input parameter's value.package1