CPcpanel
SSH Keys and Connections

Validate SSH connection to another server

This function tests an SSH connection to another server.

get/check_remote_ssh_connection

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

hoststring domain required
Example:example.com

The remote server's hostname.

portinteger
Example:22

The remote server's port number.

Response

HTTP Request was successful.

Example response

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

Changes

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