CPcpanel
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

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

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
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.