cPanel/ssh
cPanel module

ssh

1 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="ssh", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get_shell GET#

Return whether cPanel account has shell access

This function returns whether the cPanel account has shell access and the account's shell path.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

has_terminal_accessboolean
Whether the cPanel account has shell access. true - Account has shell access. false - Account does not have shell access.
shellstring
The cPanel account's shell path.