cPanel/list_cpanel_accounts
Tool · cPanel

list_cpanel_accounts

List the cPanel accounts on one of the caller's Managed VPS (cPanel) services, by service ID: user, domain, plan, suspended flag, and disk used/limit. System accounts (root, nobody, the WHM user) are never listed. Pass a returned user as cpanel_user to cpanel_uapi. A service that is not an active managed cPanel VPS, or not the caller's, returns error="not_found". Requires the cpanel:uapi scope.

Read-onlyIdempotentOpen‑worldscope cpanel:uapi

Invoked over the MCP transport with a tools/call request naming this tool.

Authorization #

Requires a valid OAuth 2.1 bearer access_token whose grant includes the cpanel:uapi scope — Manage your hosting account via cPanel — read and change settings on the cPanel features JetHost has enabled (this can modify your account). The broker resolves the caller from the token and returns only records the account owns.

Parameters #

service_idintegerRequired
The Managed VPS (cPanel) service ID. Obtain it via list_services.

Response #

200 · application/json

service_idinteger
accountsarray<object>
userstring
domainstring
planstring
suspendedboolean
diskusedstring
disklimitstring
messagestring

Errors #

ResultWhen
{ "error": "internal_error" }See the tool description for when this result is returned.
{ "error": "not_found" }The requested item does not exist, or it belongs to another account. Cross-account IDs are indistinguishable from missing ones by design.
{ "error": "backend_error" }See the tool description for when this result is returned.