cPanel XMLAPI - addpkg


DESCRIPTION

This function adds a new hosting package.


VARIABLES

INPUT

name (string)
Name of the package.

featurelist (string)
Name of the feature list to be used for the package.

quota (integer)
Disk space quota for the package (in MB). (max is unlimited)

ip (boolean)
Whether or not the account has a dedicated IP. Yes=1, No=0.

cgi (boolean)
Whether or not the account has cgi access. Yes=1, No=0.

frontpage (boolean)
Whether or not the account can install FrontPage extensions. Yes=1, No=0.

cpmod (string)
What to change the default package them to. Format: cpmod=themename

language (string)
Name of the language to be used by default for this package.

maxftp (integer)
The maximum amount of FTP accounts a user assigned to the package can create. (max is 999)

maxsql (integer)
The maximum amount of SQL databases a user assigned to the package can create. (max is 999)

maxpop (integer)
The maximum amount of email accounts a user assigned to the package can create. (max is 999)

maxlists (integer)
The maximum amount of email lists a user assigned to the package can create. (max is 999)

maxsub (integer)
The maximum amount of subdomains a user assigned to the package can create. (max is 999)

maxpark (integer)
The maximum amount of parked domains a user assigned to the package can create. (max is 999)

maxaddon (integer)
The maximum amount of addon domains a user assigned to the package can create. (max is 999)

hasshell (boolean)
Whether or not the account has shell access. Yes=1, No=0.

bwlimit (integer)
The maximum amount of bandwidth the account can use in a month. (max is unlimited)

OUTPUT

addpkg
Add Package container

result
Result of package addition.

pkg (string)
Name of package. Format: pkg=``name''

status (boolean)
Whether or not the operation was successful. Yes=1, No=0. Format: status=``0|1''

statusmsg (string)
Message as a result of the operation. Format: statusmsg=``message''


EXAMPLES

Calling this URL in WebHost Manager: /xml-api/addpkg?name=ben&featurelist=Default&quota=0&ip=1&cgi=1&frontpage=1&cpmod=x3&maxftp=9&maxsql=99&maxpop=999&maxlst=999&maxsub=888&maxpark=88&maxaddon=888&hasshell=1&bwlimit=9999

will produce:

<addpkg>

<result pkg=``ben'' status=``1'' statusmsg=``Created the package ben''/>

</addpkg>

This will add the package ``ben'' with the settings listed in the call.


COPYRIGHT

Copyright 2007 cPanel Inc.