latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Packages
Hosting Plans

Return current user's available hosting plans

This function lists the authenticated user's available hosting plans (packages).

Important:

This function only returns packages that the authenticated user can access and use during account creation.

get/listpkgs

Query parameters

want'all' | 'creatable' | 'editable' | 'viewable'
Example:all

The permissions of packages that you wish to list.

  • all — All packages on the system.
  • creatable — Packages that the authenticated user can use for accounts.
  • editable — Packages that the authenticated user can edit.
  • viewable — Packages that the authenticated user can view.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "pkg": [
      {
        "CGI": "y",
        "CPMOD": "jupiter",
        "DIGESTAUTH": "n",
        "FEATURELIST": "myfeaturelist",
        "HASSHELL": "n",
        "IP": "n",
        "LANG": "en",
        "MAX_TEAM_USERS": 7,
        "name": "package1"
      }
    ]
  },
  "metadata": {
    "command": "listpkgs",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}