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.

SecurityBasicAuth

Request

query Parameters

want

string

Default: "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.

Enum: "all" "creatable" "editable" "viewable"

Example: want=all

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/listpkgs

Request samples

whmapi1 --output=jsonpretty \
  listpkgs

Response samples

application/json

{"data": {"pkg": [{"BWLIMIT": "unlimited",
"CGI": "y",
"CPMOD": "jupiter",
"DIGESTAUTH": "n",
"FEATURELIST": "myfeaturelist",
"HASSHELL": "n",
"IP": "n",
"LANG": "en",
"MAXADDON": "unlimited",
"MAXFTP": "unlimited",
"MAXLST": "unlimited",
"MAXPARK": "unlimited",
"MAXPOP": "unlimited",
"MAXSQL": "unlimited",
"MAXSUB": "unlimited",
"MAX_DEFER_FAIL_PERCENTAGE": "unlimited",
"MAX_EMAILACCT_QUOTA": "unlimited",
"MAX_EMAIL_PER_HOUR": "unlimited",
"MAX_TEAM_USERS": 7,
"QUOTA": "unlimited",
"_PACKAGE_EXTENSIONS": "",
"name": "package1"
}
]
},
"metadata": {"command": "listpkgs",
"reason": "OK",
"result": 1,
"version": 1
}
}