Return whether cPanel account has shell access

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

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/ssh/get_shell

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  SSH \
  get_shell

Response samples

application/json

{"apiversion": 3,
"func": "get_shell",
"module": "SSH",
"result": {"data": {"has_terminal_access": true,
"shell": "/bin/bash"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}