Validate SSH connection to another server

This function tests an SSH connection to another server.

SecurityBasicAuth
Request
query Parameters
host
required
string <domain>

The remote server's hostname.

Example: host=example.com
port
integer >= 1
Default: 22

The remote server's port number.

Example: port=22
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/check_remote_ssh_connection
Request samples
whmapi1 --output=jsonpretty \
  check_remote_ssh_connection \
  host='example.com'
Response samples
application/json
{
  • "data": {
    • "comment": "null",
    • "protocol_versions": [
      • "2.0"
      ],
    • "received": "SSH-2.0-OpenSSH_5.3",
    • "server_software": "OpenSSH_5.3"
    },
  • "metadata": {
    • "command": "check_remote_ssh_connection",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}