---
title: "Validate SSH connection to another server"
method: GET
path: "/check_remote_ssh_connection"
tags: ["SSH Keys and Connections"]
---

# Validate SSH connection to another server

`GET /check_remote_ssh_connection`

This function tests an SSH connection to another server.

## Query parameters

- `host` string, domain, required
- `port` integer

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `comment` string — The remote connection's comment section. * A valid string. * `undef` - If the local and remote servers connect successfully.
    - `protocol_versions` string[] — The available SSH protocol versions. * A valid string. * `undef` - If the local and remote servers connect successfully.
    - `received` string — The raw data from the remote server.
    - `server_software` string — The version of the remote server's SSH server software. * A valid string. * `undef` - If the local and remote servers connect successfully.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)