Edit a Package — editpkg

This function edits all aspects of a specific hosting package.

Warning: Editing a package will cause all accounts using that package to be updated to the new values defined in the package.

Calling Functions

Using the XML API

Using the JSON API

Variables

Input

The following variable is required:

• name (string) — Name of the package you wish to edit.

The following variables are optional:

• featurelist (string) — Name of the feature list to be used for the package.
• quota (integer) — Disk space quota for the package (in Megabytes). Maximum: unlimited
• ip (boolean) — Whether or not the account has a dedicated IP.
  • 1 — yes.
  • 0 — no.
• cgi (boolean) — Whether or not the account has CGI access.
  • 1 — yes.
  • 0 — no.
• frontpage (boolean) — Whether or not the account can install FrontPage extensions.
  • 1 — yes.
  • 0 — no.
• cpmod (string) — The default theme for the package.
  • If no value is provided, the function will use the cPanel default theme (set in WHM in the Basic cPanel & WHM Setup screen). This behavior only applies to version 11.36+.
  • If no value is provided, and the package has an existing theme, then the function will use the existing theme. This behavior only applies to version 11.36+.
• language (string) — Name of the language to be used for this package by default.
• maxftp (integer) — The number of FTP accounts a user assigned to the package can create. Maximum: 999
• maxsql (integer) — The number of SQL databases a user assigned to the package can create. Maximum: 999
• maxpop (integer) — The number of email accounts a user assigned to the package can create. Maximum: 999
• maxlists (integer) — The number of email lists a user assigned to the package can create. Maximum: 999
• maxsub (integer) — The number of subdomains a user assigned to the package can create. Maximum: 999
• maxpark (integer) — The number of parked domains a user assigned to the package can create. Maximum: 999
• maxaddon (integer) — The number of addon domains a user assigned to the package can create. Maximum: 999
• hasshell (boolean) — Whether or not the account has shell access.
  • 1 — yes.
  • 0 — no.
• bwlimit (integer) — The amount of bandwidth the account can use in a month. Maximum: unlimited
• MAX_EMAIL_PER_HOUR (integer) — The maximum number of emails the account can send in an hour. This parameter's default value is unlimited. Entering 0 here will result in an unlimited value. This variable is only accepted in version 11.32+.
• MAX_DEFER_FAIL_PERCENTAGE (integer) — The percentage of failed or deferred email messages the account can send per hour before outgoing mail is rate-limited. The system only applies this value after the MIN_DEFER_FAIL_TO_TRIGGER_PROTECTION value is met. This parameter's default value is unlimited. This variable is only accepted in version 11.32+.
• MIN_DEFER_FAIL_TO_TRIGGER_PROTECTION (integer) — The minimum number of failed or deferred email messages the account can send before outgoing mail is subject to rate-limiting (according to the percentage set by the MAX_DEFER_FAIL_PERCENTAGE value). This parameter's default value is unlimited. This variable is only accepted in version 11.32+.
• digestauth (boolean) — Whether or not the account should have digest authentication enabled. This variable is only accepted in version 11.34+.
  • 1 — yes.
  • 0 — no.

Output

Examples

XML API

<editpkg>
     <result>
            <pkg>packagename</pkg>
            <status>1</status>
            <statusmsg>Modified the package packagename</statusmsg>
      </result>
</editpkg>

JSON API

{
   "result":[
      {
         "status":1,
         "statusmsg":"Modified the package packagename",
         "changepackage":[

         ],
         "pkg":"packagename"
      }
   ]
}