v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

SSH

Return whether cPanel account has shell access

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

get/SSH/get_shell

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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