cPanel XMLAPI - listpkgs


DESCRIPTION

This function lists all hosting packages on a server.


VARIABLES

INPUT

NONE

OUTPUT

listpkgs
List of all hosting packages container.

package
Hosting Package container.

name (string)
Name of the hosting package.

BWLIMIT (integer)
Bandwidth usage limit associated with package (in MB). Format: XXXX

CGI (integer)
Whether or not the account will have the ability to execute CGI scripts (y,n)

CPMOD (string)
Name of the theme associated with the package.

FEATURELIST (string)
Name of the feature list associated with the package.

FRONTPAGE (string)
Whether or not FrontPage extensions are enabled on the account. (y,n)

HASSHELL (string)
Whether or not the account will have SSH / Shell access. (y,n)

IP (string)
Whether or not the account will have a dedicated IP. (y,n)

MAXADDON (integer)
Maximum number of Addon Domains the account will be able to create.

MAXFTP (integer)
Maximum number of FTP accounts the account will be able to create.

MAXLST (integer)
Maximum number of mailing lists the account will be able to create.

MAXPARK (integer)
Maximum number of Parked Domains the account will be able to create.

MAXPOP (integer)
Maximum number of email accounts the account will be able to create.

MAXSQL (integer)
Maximum number of SQL(MySQL and PostgreSQL) databases the account will be able to create.

MAXSUB (integer)
Maximum number of Sub Domains the account will be able to create.

QUOTA (integer)
disk space usage quota associated with the package (in MB). Format: XXXX


EXAMPLES

Calling this URL in WebHost Manager: /xml-api/listpkgs

will produce XML similar to:

<listpkgs>

<package name=``gold_1000MB'' BWLIMIT=``1000'' CGI=``y'' CPMOD=``x3'' FEATURELIST=``default'' FRONTPAGE=``n'' HASSHELL=``n'' IP=``n'' MAXADDON=``3'' MAXFTP=``5'' MAXLST=``5'' MAXPARK=``3'' MAXPOP=``30'' MAXSQL=``5'' MAXSUB=``10'' QUOTA=``1000''/>

</listpkgs>

Note that the package containers will contain all of the packages present on the system this URL is called on.


COPYRIGHT

Copyright 2007 cPanel Inc.